v20201029

package
v1.0.636 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
	DRYRUNOPERATION = "DryRunOperation"

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

	// 修改资源信息失败。
	FAILEDOPERATION_MODIFYRESOURCEINFOERROR = "FailedOperation.ModifyResourceInfoError"

	// 访问管控服务失败，请稍后重试。如果持续不成功，请联系客服进行处理。
	FAILEDOPERATION_OSSACCESSERROR = "FailedOperation.OssAccessError"

	// 查询资源信息失败。
	FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"

	// 获取独享集群规格信息失败。
	FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 参数值传入错误。
	INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

	// 集群的参数非法。
	INVALIDPARAMETERVALUE_RESOURCEPARAMETERERROR = "InvalidParameterValue.ResourceParameterError"

	// 获取资源失败，AppId：{{1}}，ResourceId：{{2}}。
	RESOURCENOTFOUND_FETCHRESOURCEERROR = "ResourceNotFound.FetchResourceError"

	// 获取资源列表失败，ErrMsg：{{1}}。
	RESOURCENOTFOUND_FETCHRESOURCELISTERROR = "ResourceNotFound.FetchResourceListError"

	// 资源状态异常。
	RESOURCEUNAVAILABLE_RESOURCESTATUSABNORMALERROR = "ResourceUnavailable.ResourceStatusAbnormalError"
)
View Source 
const APIVersion = "2020-10-29"

Variables

This section is empty.

Functions

This section is empty.

Types

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) DescribeDBInstances 

func (c *Client) DescribeDBInstances(request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)

DescribeDBInstances 本接口用于查询独享集群内的DB实例列表

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_OSSACCESSERROR = "FailedOperation.OssAccessError"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) DescribeDBInstancesWithContext 

func (c *Client) DescribeDBInstancesWithContext(ctx context.Context, request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)

DescribeDBInstances 本接口用于查询独享集群内的DB实例列表

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_OSSACCESSERROR = "FailedOperation.OssAccessError"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) DescribeHostList added in v1.0.433 

func (c *Client) DescribeHostList(request *DescribeHostListRequest) (response *DescribeHostListResponse, err error)

DescribeHostList 本接口用于查询主机列表

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"
RESOURCEUNAVAILABLE_RESOURCESTATUSABNORMALERROR = "ResourceUnavailable.ResourceStatusAbnormalError"

func (*Client) DescribeHostListWithContext added in v1.0.433 

func (c *Client) DescribeHostListWithContext(ctx context.Context, request *DescribeHostListRequest) (response *DescribeHostListResponse, err error)

DescribeHostList 本接口用于查询主机列表

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"
RESOURCEUNAVAILABLE_RESOURCESTATUSABNORMALERROR = "ResourceUnavailable.ResourceStatusAbnormalError"

func (*Client) DescribeInstanceDetail 

func (c *Client) DescribeInstanceDetail(request *DescribeInstanceDetailRequest) (response *DescribeInstanceDetailResponse, err error)

DescribeInstanceDetail 本接口用于查询独享集群详情

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) DescribeInstanceDetailWithContext 

func (c *Client) DescribeInstanceDetailWithContext(ctx context.Context, request *DescribeInstanceDetailRequest) (response *DescribeInstanceDetailResponse, err error)

DescribeInstanceDetail 本接口用于查询独享集群详情

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) DescribeInstanceList 

func (c *Client) DescribeInstanceList(request *DescribeInstanceListRequest) (response *DescribeInstanceListResponse, err error)

DescribeInstanceList 本接口用于查询独享集群实例列表

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) DescribeInstanceListWithContext 

func (c *Client) DescribeInstanceListWithContext(ctx context.Context, request *DescribeInstanceListRequest) (response *DescribeInstanceListResponse, err error)

DescribeInstanceList 本接口用于查询独享集群实例列表

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
FAILEDOPERATION_QUERYSPECINFOERROR = "FailedOperation.QuerySpecInfoError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) DescribeInstances 

func (c *Client) DescribeInstances(request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

DescribeInstances 根据不同地域不同用户，获取集群列表信息

可能返回的错误码: 

INVALIDPARAMETERVALUE_RESOURCEPARAMETERERROR = "InvalidParameterValue.ResourceParameterError"
RESOURCENOTFOUND_FETCHRESOURCEERROR = "ResourceNotFound.FetchResourceError"
RESOURCENOTFOUND_FETCHRESOURCELISTERROR = "ResourceNotFound.FetchResourceListError"

func (*Client) DescribeInstancesWithContext 

func (c *Client) DescribeInstancesWithContext(ctx context.Context, request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

DescribeInstances 根据不同地域不同用户，获取集群列表信息

可能返回的错误码: 

INVALIDPARAMETERVALUE_RESOURCEPARAMETERERROR = "InvalidParameterValue.ResourceParameterError"
RESOURCENOTFOUND_FETCHRESOURCEERROR = "ResourceNotFound.FetchResourceError"
RESOURCENOTFOUND_FETCHRESOURCELISTERROR = "ResourceNotFound.FetchResourceListError"

func (*Client) ModifyInstanceName 

func (c *Client) ModifyInstanceName(request *ModifyInstanceNameRequest) (response *ModifyInstanceNameResponse, err error)

ModifyInstanceName 本接口用于修改集群名称

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_MODIFYRESOURCEINFOERROR = "FailedOperation.ModifyResourceInfoError"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

func (*Client) ModifyInstanceNameWithContext 

func (c *Client) ModifyInstanceNameWithContext(ctx context.Context, request *ModifyInstanceNameRequest) (response *ModifyInstanceNameResponse, err error)

ModifyInstanceName 本接口用于修改集群名称

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION_MODIFYRESOURCEINFOERROR = "FailedOperation.ModifyResourceInfoError"
FAILEDOPERATION_QUERYRESOURCEERROR = "FailedOperation.QueryResourceError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUEERROR = "InvalidParameterValue.InvalidParameterValueError"

type DBInstanceDetail 

type DBInstanceDetail struct {
	// DB实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

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

	// DB实例状态,-1:已隔离, 0:创建中, 1:流程中, 2:运行中, 3:未初始化
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// DB实例状态描述,-1:已隔离, 0:创建中, 1:流程中, 2:运行中, 3:未初始化
	StatusDesc *string `json:"StatusDesc,omitempty" name:"StatusDesc"`

	// DB实例版本
	DbVersion *string `json:"DbVersion,omitempty" name:"DbVersion"`

	// Vip信息
	Vip *string `json:"Vip,omitempty" name:"Vip"`

	// Vip使用的端口号
	Vport *int64 `json:"Vport,omitempty" name:"Vport"`

	// 字符串型的私有网络ID
	UniqueVpcId *string `json:"UniqueVpcId,omitempty" name:"UniqueVpcId"`

	// 字符串型的私有网络子网ID
	UniqueSubnetId *string `json:"UniqueSubnetId,omitempty" name:"UniqueSubnetId"`

	// 是否为分布式版本,0:否,1:是
	Shard *int64 `json:"Shard,omitempty" name:"Shard"`

	// DB实例节点数
	NodeNum *int64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// CPU规格(单位:核数)
	Cpu *int64 `json:"Cpu,omitempty" name:"Cpu"`

	// 内存规格(单位:GB)
	Memory *int64 `json:"Memory,omitempty" name:"Memory"`

	// 磁盘规格(单位:GB)
	Disk *int64 `json:"Disk,omitempty" name:"Disk"`

	// 分布式类型的实例的分片数
	ShardNum *int64 `json:"ShardNum,omitempty" name:"ShardNum"`

	// 地域
	Region *string `json:"Region,omitempty" name:"Region"`

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

	// Db所在主机列表, 格式: m1,s1|m2,s2
	DbHosts *string `json:"DbHosts,omitempty" name:"DbHosts"`

	// 主机角色, 1:主, 2:从, 3:主+从
	HostRole *int64 `json:"HostRole,omitempty" name:"HostRole"`

	// DB引擎，MySQL,Percona,MariaDB
	DbEngine *string `json:"DbEngine,omitempty" name:"DbEngine"`

	// 创建时间
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`
}

type DescribeDBInstancesRequest 

type DescribeDBInstancesRequest struct {
	*tchttp.BaseRequest

	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 独享集群主机Id
	HostId *string `json:"HostId,omitempty" name:"HostId"`

	// 分页返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 分页偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 实例类型,0:mariadb, 1:tdsql
	ShardType []*int64 `json:"ShardType,omitempty" name:"ShardType"`
}

func NewDescribeDBInstancesRequest 

func NewDescribeDBInstancesRequest() (request *DescribeDBInstancesRequest)

func (*DescribeDBInstancesRequest) FromJsonString 

func (r *DescribeDBInstancesRequest) 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 (*DescribeDBInstancesRequest) ToJsonString 

func (r *DescribeDBInstancesRequest) ToJsonString() string

type DescribeDBInstancesRequestParams added in v1.0.426 

type DescribeDBInstancesRequestParams struct {
	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 独享集群主机Id
	HostId *string `json:"HostId,omitempty" name:"HostId"`

	// 分页返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 分页偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 实例类型,0:mariadb, 1:tdsql
	ShardType []*int64 `json:"ShardType,omitempty" name:"ShardType"`
}

Predefined struct for user

type DescribeDBInstancesResponse 

type DescribeDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDBInstancesResponseParams `json:"Response"`
}

func NewDescribeDBInstancesResponse 

func NewDescribeDBInstancesResponse() (response *DescribeDBInstancesResponse)

func (*DescribeDBInstancesResponse) FromJsonString 

func (r *DescribeDBInstancesResponse) 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 (*DescribeDBInstancesResponse) ToJsonString 

func (r *DescribeDBInstancesResponse) ToJsonString() string

type DescribeDBInstancesResponseParams added in v1.0.426 

type DescribeDBInstancesResponseParams struct {
	// 独享集群内的DB实例列表
	Instances []*DBInstanceDetail `json:"Instances,omitempty" name:"Instances"`

	// 独享集群内的DB实例总数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeHostListRequest added in v1.0.433 

type DescribeHostListRequest struct {
	*tchttp.BaseRequest

	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 分页返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 分页偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 分配状态过滤，0-可分配，1-禁止分配
	AssignStatus []*int64 `json:"AssignStatus,omitempty" name:"AssignStatus"`
}

func NewDescribeHostListRequest added in v1.0.433 

func NewDescribeHostListRequest() (request *DescribeHostListRequest)

func (*DescribeHostListRequest) FromJsonString added in v1.0.433 

func (r *DescribeHostListRequest) 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 (*DescribeHostListRequest) ToJsonString added in v1.0.433 

func (r *DescribeHostListRequest) ToJsonString() string

type DescribeHostListRequestParams added in v1.0.433 

type DescribeHostListRequestParams struct {
	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 分页返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 分页偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 分配状态过滤，0-可分配，1-禁止分配
	AssignStatus []*int64 `json:"AssignStatus,omitempty" name:"AssignStatus"`
}

Predefined struct for user

type DescribeHostListResponse added in v1.0.433 

type DescribeHostListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeHostListResponseParams `json:"Response"`
}

func NewDescribeHostListResponse added in v1.0.433 

func NewDescribeHostListResponse() (response *DescribeHostListResponse)

func (*DescribeHostListResponse) FromJsonString added in v1.0.433 

func (r *DescribeHostListResponse) 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 (*DescribeHostListResponse) ToJsonString added in v1.0.433 

func (r *DescribeHostListResponse) ToJsonString() string

type DescribeHostListResponseParams added in v1.0.433 

type DescribeHostListResponseParams struct {
	// 主机总数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 主机详情
	Hosts []*HostDetail `json:"Hosts,omitempty" name:"Hosts"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceDetail 

type DescribeInstanceDetail struct {
	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 独享集群实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 地域
	Region *string `json:"Region,omitempty" name:"Region"`

	// 产品ID, 0:CDB, 1:TDSQL
	ProductId *int64 `json:"ProductId,omitempty" name:"ProductId"`

	// 集群类型, 0:公有云, 1:金融围笼, 2:CDC集群
	Type *int64 `json:"Type,omitempty" name:"Type"`

	// 主机类型, 0:物理机, 1:CVM机型, 2:CDC机型
	HostType *int64 `json:"HostType,omitempty" name:"HostType"`

	// 自动续费标志, 0:未设置, 1:自动续费, 2:到期不续费
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitempty" name:"AutoRenewFlag"`

	// 集群状态
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 集群状态描述
	StatusDesc *string `json:"StatusDesc,omitempty" name:"StatusDesc"`

	// 创建时间
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// 到期时间
	PeriodEndTime *string `json:"PeriodEndTime,omitempty" name:"PeriodEndTime"`

	// 主机数
	HostNum *int64 `json:"HostNum,omitempty" name:"HostNum"`

	// DB实例数
	DbNum *int64 `json:"DbNum,omitempty" name:"DbNum"`

	// 分配策略, 0:紧凑, 1:均匀
	AssignStrategy *int64 `json:"AssignStrategy,omitempty" name:"AssignStrategy"`

	// 总主机CPU(单位:核数)
	CpuSpec *int64 `json:"CpuSpec,omitempty" name:"CpuSpec"`

	// 总已分配CPU(单位:核数)
	CpuAssigned *int64 `json:"CpuAssigned,omitempty" name:"CpuAssigned"`

	// 总可分配CPU(单位:核数)
	CpuAssignable *int64 `json:"CpuAssignable,omitempty" name:"CpuAssignable"`

	// 总主机内存(单位:GB)
	MemorySpec *int64 `json:"MemorySpec,omitempty" name:"MemorySpec"`

	// 总已分配内存(单位:GB)
	MemoryAssigned *int64 `json:"MemoryAssigned,omitempty" name:"MemoryAssigned"`

	// 总可分配内存(单位:GB)
	MemoryAssignable *int64 `json:"MemoryAssignable,omitempty" name:"MemoryAssignable"`

	// 总机器磁盘(单位:GB)
	DiskSpec *int64 `json:"DiskSpec,omitempty" name:"DiskSpec"`

	// 总已分配磁盘(单位:GB)
	DiskAssigned *int64 `json:"DiskAssigned,omitempty" name:"DiskAssigned"`

	// 总可分配磁盘(单位:GB)
	DiskAssignable *int64 `json:"DiskAssignable,omitempty" name:"DiskAssignable"`

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

	// 金融围笼ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FenceId *string `json:"FenceId,omitempty" name:"FenceId"`

	// 所属集群ID(默认集群为空)
	// 注意：此字段可能返回 null，表示取不到有效值。
	ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"`
}

type DescribeInstanceDetailRequest 

type DescribeInstanceDetailRequest struct {
	*tchttp.BaseRequest

	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceDetailRequest 

func NewDescribeInstanceDetailRequest() (request *DescribeInstanceDetailRequest)

func (*DescribeInstanceDetailRequest) FromJsonString 

func (r *DescribeInstanceDetailRequest) 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 (*DescribeInstanceDetailRequest) ToJsonString 

func (r *DescribeInstanceDetailRequest) ToJsonString() string

type DescribeInstanceDetailRequestParams added in v1.0.426 

type DescribeInstanceDetailRequestParams struct {
	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceDetailResponse 

type DescribeInstanceDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceDetailResponseParams `json:"Response"`
}

func NewDescribeInstanceDetailResponse 

func NewDescribeInstanceDetailResponse() (response *DescribeInstanceDetailResponse)

func (*DescribeInstanceDetailResponse) FromJsonString 

func (r *DescribeInstanceDetailResponse) 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 (*DescribeInstanceDetailResponse) ToJsonString 

func (r *DescribeInstanceDetailResponse) ToJsonString() string

type DescribeInstanceDetailResponseParams added in v1.0.426 

type DescribeInstanceDetailResponseParams struct {
	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 独享集群实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 地域
	Region *string `json:"Region,omitempty" name:"Region"`

	// 产品ID, 0:CDB, 1:TDSQL
	ProductId *int64 `json:"ProductId,omitempty" name:"ProductId"`

	// 集群类型, 0:公有云, 1:金融围笼
	Type *int64 `json:"Type,omitempty" name:"Type"`

	// 主机类型, 0:物理机, 1:cvm本地盘, 2:cvm云盘
	HostType *int64 `json:"HostType,omitempty" name:"HostType"`

	// 自动续费标志, 0:未设置, 1:自动续费, 2:到期不续费
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitempty" name:"AutoRenewFlag"`

	// 集群状态
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 集群状态描述
	StatusDesc *string `json:"StatusDesc,omitempty" name:"StatusDesc"`

	// 创建时间
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// 到期时间
	PeriodEndTime *string `json:"PeriodEndTime,omitempty" name:"PeriodEndTime"`

	// 主机数
	HostNum *int64 `json:"HostNum,omitempty" name:"HostNum"`

	// Db实例数
	DbNum *int64 `json:"DbNum,omitempty" name:"DbNum"`

	// 分配策略, 0:紧凑, 1:均匀
	AssignStrategy *int64 `json:"AssignStrategy,omitempty" name:"AssignStrategy"`

	// 总主机CPU(单位:核)
	CpuSpec *int64 `json:"CpuSpec,omitempty" name:"CpuSpec"`

	// 总已分配CPU(单位:核)
	CpuAssigned *int64 `json:"CpuAssigned,omitempty" name:"CpuAssigned"`

	// 总可分配CPU(单位:核)
	CpuAssignable *int64 `json:"CpuAssignable,omitempty" name:"CpuAssignable"`

	// 总主机内存(单位:GB)
	MemorySpec *int64 `json:"MemorySpec,omitempty" name:"MemorySpec"`

	// 总已分配内存(单位:GB)
	MemoryAssigned *int64 `json:"MemoryAssigned,omitempty" name:"MemoryAssigned"`

	// 总可分配内存(单位:GB)
	MemoryAssignable *int64 `json:"MemoryAssignable,omitempty" name:"MemoryAssignable"`

	// 总机器磁盘(单位:GB)
	DiskSpec *int64 `json:"DiskSpec,omitempty" name:"DiskSpec"`

	// 总已分配磁盘(单位:GB)
	DiskAssigned *int64 `json:"DiskAssigned,omitempty" name:"DiskAssigned"`

	// 总可分配磁盘(单位:GB)
	DiskAssignable *int64 `json:"DiskAssignable,omitempty" name:"DiskAssignable"`

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

	// 金融围笼ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	FenceId *string `json:"FenceId,omitempty" name:"FenceId"`

	// 所属集群ID(默认集群为空)
	// 注意：此字段可能返回 null，表示取不到有效值。
	ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstanceListRequest 

type DescribeInstanceListRequest struct {
	*tchttp.BaseRequest

	// 分页返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 分页偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 排序字段，createTime,instancename两者之一
	OrderBy *string `json:"OrderBy,omitempty" name:"OrderBy"`

	// 排序规则，desc,asc两者之一
	SortBy *string `json:"SortBy,omitempty" name:"SortBy"`

	// 按产品过滤，0:CDB, 1:TDSQL
	ProductId []*int64 `json:"ProductId,omitempty" name:"ProductId"`

	// 按实例ID过滤
	InstanceId []*string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 按实例名称过滤
	InstanceName []*string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 按金融围笼ID过滤
	FenceId []*string `json:"FenceId,omitempty" name:"FenceId"`

	// 按实例状态过滤, -1:已隔离, 0:创建中, 1:运行中, 2:扩容中, 3:删除中
	Status []*int64 `json:"Status,omitempty" name:"Status"`

	// 按所属集群ID过滤
	ClusterId []*string `json:"ClusterId,omitempty" name:"ClusterId"`
}

func NewDescribeInstanceListRequest 

func NewDescribeInstanceListRequest() (request *DescribeInstanceListRequest)

func (*DescribeInstanceListRequest) FromJsonString 

func (r *DescribeInstanceListRequest) 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 (*DescribeInstanceListRequest) ToJsonString 

func (r *DescribeInstanceListRequest) ToJsonString() string

type DescribeInstanceListRequestParams added in v1.0.426 

type DescribeInstanceListRequestParams struct {
	// 分页返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 分页偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 排序字段，createTime,instancename两者之一
	OrderBy *string `json:"OrderBy,omitempty" name:"OrderBy"`

	// 排序规则，desc,asc两者之一
	SortBy *string `json:"SortBy,omitempty" name:"SortBy"`

	// 按产品过滤，0:CDB, 1:TDSQL
	ProductId []*int64 `json:"ProductId,omitempty" name:"ProductId"`

	// 按实例ID过滤
	InstanceId []*string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 按实例名称过滤
	InstanceName []*string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 按金融围笼ID过滤
	FenceId []*string `json:"FenceId,omitempty" name:"FenceId"`

	// 按实例状态过滤, -1:已隔离, 0:创建中, 1:运行中, 2:扩容中, 3:删除中
	Status []*int64 `json:"Status,omitempty" name:"Status"`

	// 按所属集群ID过滤
	ClusterId []*string `json:"ClusterId,omitempty" name:"ClusterId"`
}

Predefined struct for user

type DescribeInstanceListResponse 

type DescribeInstanceListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceListResponseParams `json:"Response"`
}

func NewDescribeInstanceListResponse 

func NewDescribeInstanceListResponse() (response *DescribeInstanceListResponse)

func (*DescribeInstanceListResponse) FromJsonString 

func (r *DescribeInstanceListResponse) 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 (*DescribeInstanceListResponse) ToJsonString 

func (r *DescribeInstanceListResponse) ToJsonString() string

type DescribeInstanceListResponseParams added in v1.0.426 

type DescribeInstanceListResponseParams struct {
	// 独享集群列表
	Instances []*DescribeInstanceDetail `json:"Instances,omitempty" name:"Instances"`

	// 独享集群实例总数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstancesRequest 

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

	// 集群类型: 0 一主一备, 1 一主两备...N-1 一主N备
	InstanceTypes []*int64 `json:"InstanceTypes,omitempty" name:"InstanceTypes"`

	// 产品ID:  0 MYSQL，1 TDSQL
	ProductIds []*int64 `json:"ProductIds,omitempty" name:"ProductIds"`

	// 集群uuid: 如 dbdc-q810131s
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// 是否按金融围笼标志搜索
	FenceFlag *bool `json:"FenceFlag,omitempty" name:"FenceFlag"`

	// 按实例名字模糊匹配
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 每页数目, 整型
	PageSize *int64 `json:"PageSize,omitempty" name:"PageSize"`

	// 页码, 整型
	PageNumber *int64 `json:"PageNumber,omitempty" name:"PageNumber"`

	// 排序字段，枚举：createtime,groupname
	OrderBy *string `json:"OrderBy,omitempty" name:"OrderBy"`

	// 排序方式: asc升序, desc降序
	OrderByType *string `json:"OrderByType,omitempty" name:"OrderByType"`

	// 集群状态: -2 已删除, -1 已隔离, 0 创建中, 1 运行中, 2 扩容中, 3 删除中
	InstanceStatus *int64 `json:"InstanceStatus,omitempty" name:"InstanceStatus"`
}

func NewDescribeInstancesRequest 

func NewDescribeInstancesRequest() (request *DescribeInstancesRequest)

func (*DescribeInstancesRequest) FromJsonString 

func (r *DescribeInstancesRequest) 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 (*DescribeInstancesRequest) ToJsonString 

func (r *DescribeInstancesRequest) ToJsonString() string

type DescribeInstancesRequestParams added in v1.0.426 

type DescribeInstancesRequestParams struct {
	// 集群类型: 0 一主一备, 1 一主两备...N-1 一主N备
	InstanceTypes []*int64 `json:"InstanceTypes,omitempty" name:"InstanceTypes"`

	// 产品ID:  0 MYSQL，1 TDSQL
	ProductIds []*int64 `json:"ProductIds,omitempty" name:"ProductIds"`

	// 集群uuid: 如 dbdc-q810131s
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// 是否按金融围笼标志搜索
	FenceFlag *bool `json:"FenceFlag,omitempty" name:"FenceFlag"`

	// 按实例名字模糊匹配
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 每页数目, 整型
	PageSize *int64 `json:"PageSize,omitempty" name:"PageSize"`

	// 页码, 整型
	PageNumber *int64 `json:"PageNumber,omitempty" name:"PageNumber"`

	// 排序字段，枚举：createtime,groupname
	OrderBy *string `json:"OrderBy,omitempty" name:"OrderBy"`

	// 排序方式: asc升序, desc降序
	OrderByType *string `json:"OrderByType,omitempty" name:"OrderByType"`

	// 集群状态: -2 已删除, -1 已隔离, 0 创建中, 1 运行中, 2 扩容中, 3 删除中
	InstanceStatus *int64 `json:"InstanceStatus,omitempty" name:"InstanceStatus"`
}

Predefined struct for user

type DescribeInstancesResponse 

type DescribeInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesResponseParams `json:"Response"`
}

func NewDescribeInstancesResponse 

func NewDescribeInstancesResponse() (response *DescribeInstancesResponse)

func (*DescribeInstancesResponse) FromJsonString 

func (r *DescribeInstancesResponse) 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 (*DescribeInstancesResponse) ToJsonString 

func (r *DescribeInstancesResponse) ToJsonString() string

type DescribeInstancesResponseParams added in v1.0.426 

type DescribeInstancesResponseParams struct {
	// 集群数量
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 集群扩展信息
	Instances []*InstanceExpand `json:"Instances,omitempty" name:"Instances"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeviceInfo 

type DeviceInfo struct {
	// 设备ID
	DeviceId *int64 `json:"DeviceId,omitempty" name:"DeviceId"`

	// 设备No
	DeviceNo *string `json:"DeviceNo,omitempty" name:"DeviceNo"`

	// 设备类型
	DevClass *string `json:"DevClass,omitempty" name:"DevClass"`

	// 设备总内存，单位GB
	MaxMemory *float64 `json:"MaxMemory,omitempty" name:"MaxMemory"`

	// 设备总磁盘，单位GB
	MaxDisk *float64 `json:"MaxDisk,omitempty" name:"MaxDisk"`

	// 设备剩余内存，单位GB
	RestMemory *float64 `json:"RestMemory,omitempty" name:"RestMemory"`

	// 设备剩余磁盘，单位GB
	RestDisk *float64 `json:"RestDisk,omitempty" name:"RestDisk"`

	// 设备机器个数
	RawDeviceNum *uint64 `json:"RawDeviceNum,omitempty" name:"RawDeviceNum"`

	// 数据库实例个数
	InstanceNum *uint64 `json:"InstanceNum,omitempty" name:"InstanceNum"`
}

type HostDetail added in v1.0.433 

type HostDetail struct {
	// 主机Id
	HostId *string `json:"HostId,omitempty" name:"HostId"`

	// 主机名称
	HostName *string `json:"HostName,omitempty" name:"HostName"`

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

	// 主机状态
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 分配DB实例状态,0:可分配,1:不可分配
	AssignStatus *int64 `json:"AssignStatus,omitempty" name:"AssignStatus"`

	// 主机类型, 0:物理机, 1:cvm本地盘, 2:cvm云盘
	HostType *int64 `json:"HostType,omitempty" name:"HostType"`

	// DB实例数
	DbNum *int64 `json:"DbNum,omitempty" name:"DbNum"`

	// 主机CPU(单位:核数)
	CpuSpec *int64 `json:"CpuSpec,omitempty" name:"CpuSpec"`

	// 已分配CPU(单位:核数)
	CpuAssigned *int64 `json:"CpuAssigned,omitempty" name:"CpuAssigned"`

	// 可分配CPU(单位:核数)
	CpuAssignable *int64 `json:"CpuAssignable,omitempty" name:"CpuAssignable"`

	// 主机内存(单位:GB)
	MemorySpec *int64 `json:"MemorySpec,omitempty" name:"MemorySpec"`

	// 已分配内存(单位:GB)
	MemoryAssigned *int64 `json:"MemoryAssigned,omitempty" name:"MemoryAssigned"`

	// 可分配内存(单位:GB)
	MemoryAssignable *int64 `json:"MemoryAssignable,omitempty" name:"MemoryAssignable"`

	// 主机磁盘(单位:GB)
	DiskSpec *int64 `json:"DiskSpec,omitempty" name:"DiskSpec"`

	// 已分配磁盘(单位:GB)
	DiskAssigned *int64 `json:"DiskAssigned,omitempty" name:"DiskAssigned"`

	// 可分配磁盘(GB)
	DiskAssignable *int64 `json:"DiskAssignable,omitempty" name:"DiskAssignable"`

	// CPU分配比
	CpuRatio *float64 `json:"CpuRatio,omitempty" name:"CpuRatio"`

	// 内存分配比
	MemoryRatio *float64 `json:"MemoryRatio,omitempty" name:"MemoryRatio"`

	// 磁盘分配比
	DiskRatio *float64 `json:"DiskRatio,omitempty" name:"DiskRatio"`

	// 机型名称
	MachineName *string `json:"MachineName,omitempty" name:"MachineName"`

	// 机型类别
	MachineType *string `json:"MachineType,omitempty" name:"MachineType"`

	// 计费标签
	PidTag *string `json:"PidTag,omitempty" name:"PidTag"`

	// 计费ID
	Pid *int64 `json:"Pid,omitempty" name:"Pid"`

	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

type InstanceDetail 

type InstanceDetail struct {
	// 集群状态，0：运行中，1：不在运行
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 读写集群剩余内存容量，单位GB
	ReadWriteTotalLeaveMemory *float64 `json:"ReadWriteTotalLeaveMemory,omitempty" name:"ReadWriteTotalLeaveMemory"`

	// 读写集群剩余磁盘容量，单位GB
	ReadWriteTotalLeaveDisk *float64 `json:"ReadWriteTotalLeaveDisk,omitempty" name:"ReadWriteTotalLeaveDisk"`

	// 读写集群总内存容量，单位GB
	ReadWriteTotalMemory *float64 `json:"ReadWriteTotalMemory,omitempty" name:"ReadWriteTotalMemory"`

	// 读写集群总磁盘容量，单位GB
	ReadWriteTotalDisk *float64 `json:"ReadWriteTotalDisk,omitempty" name:"ReadWriteTotalDisk"`

	// 只读集群剩余内存容量，单位GB
	ReadOnlyTotalLeaveMemory *float64 `json:"ReadOnlyTotalLeaveMemory,omitempty" name:"ReadOnlyTotalLeaveMemory"`

	// 只读集群剩余磁盘容量，单位GB
	ReadOnlyTotalLeaveDisk *float64 `json:"ReadOnlyTotalLeaveDisk,omitempty" name:"ReadOnlyTotalLeaveDisk"`

	// 只读集群总内存容量，单位GB
	ReadOnlyTotalMemory *float64 `json:"ReadOnlyTotalMemory,omitempty" name:"ReadOnlyTotalMemory"`

	// 只读集群总磁盘容量，单位GB
	ReadOnlyTotalDisk *float64 `json:"ReadOnlyTotalDisk,omitempty" name:"ReadOnlyTotalDisk"`

	// 集群设备详情
	InstanceDeviceInfos []*InstanceDeviceInfo `json:"InstanceDeviceInfos,omitempty" name:"InstanceDeviceInfos"`
}

type InstanceDeviceInfo 

type InstanceDeviceInfo struct {
	// 集群ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 读写设备组
	// 注意：此字段可能返回 null，表示取不到有效值。
	ReadWriteDevice []*DeviceInfo `json:"ReadWriteDevice,omitempty" name:"ReadWriteDevice"`

	// 只读设备组
	// 注意：此字段可能返回 null，表示取不到有效值。
	ReadOnlyDevice []*DeviceInfo `json:"ReadOnlyDevice,omitempty" name:"ReadOnlyDevice"`

	// 空闲设备组
	// 注意：此字段可能返回 null，表示取不到有效值。
	FreeDevice []*DeviceInfo `json:"FreeDevice,omitempty" name:"FreeDevice"`
}

type InstanceExpand 

type InstanceExpand struct {
	// 集群ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 集群名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 用户ID
	AppId *uint64 `json:"AppId,omitempty" name:"AppId"`

	// 地域
	Region *string `json:"Region,omitempty" name:"Region"`

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

	// 集群类型： 0：一主一备，1：一主两备
	InstanceType *int64 `json:"InstanceType,omitempty" name:"InstanceType"`

	// 集群状态: 0 集群创建中, 1 集群有效, 2 集群扩容中, 3 集群删除中, 4 集群缩容中 -1 集群已隔离 -2 集群已删除
	InstanceStatus *int64 `json:"InstanceStatus,omitempty" name:"InstanceStatus"`

	// 创建时间
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// 实例自动续费标识： 0正常续费 1自动续费 2到期不续费
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitempty" name:"AutoRenewFlag"`

	// 机型
	Machine *string `json:"Machine,omitempty" name:"Machine"`

	// 过期时间
	PeriodEndTime *string `json:"PeriodEndTime,omitempty" name:"PeriodEndTime"`

	// 集群信息
	InstanceDetail *InstanceDetail `json:"InstanceDetail,omitempty" name:"InstanceDetail"`

	// 计费侧的产品ID
	Pid *int64 `json:"Pid,omitempty" name:"Pid"`
}

type ModifyInstanceNameRequest 

type ModifyInstanceNameRequest struct {
	*tchttp.BaseRequest

	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 独享集群实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`
}

func NewModifyInstanceNameRequest 

func NewModifyInstanceNameRequest() (request *ModifyInstanceNameRequest)

func (*ModifyInstanceNameRequest) FromJsonString 

func (r *ModifyInstanceNameRequest) 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 (*ModifyInstanceNameRequest) ToJsonString 

func (r *ModifyInstanceNameRequest) ToJsonString() string

type ModifyInstanceNameRequestParams added in v1.0.426 

type ModifyInstanceNameRequestParams struct {
	// 独享集群实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 独享集群实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`
}

Predefined struct for user

type ModifyInstanceNameResponse 

type ModifyInstanceNameResponse struct {
	*tchttp.BaseResponse
	Response *ModifyInstanceNameResponseParams `json:"Response"`
}

func NewModifyInstanceNameResponse 

func NewModifyInstanceNameResponse() (response *ModifyInstanceNameResponse)

func (*ModifyInstanceNameResponse) FromJsonString 

func (r *ModifyInstanceNameResponse) 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 (*ModifyInstanceNameResponse) ToJsonString 

func (r *ModifyInstanceNameResponse) ToJsonString() string

type ModifyInstanceNameResponseParams added in v1.0.426 

type ModifyInstanceNameResponseParams struct {
	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

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.