;
/**
* 是否强制更换节点宿主机
枚举值:
- true: 表示允许节点更换宿主机,允许重启。本地盘节点不支持指定此参数。
- false: 不允许节点更换宿主机,只在当前宿主机上加入置放群组。这可能导致更换置放群组失败。
默认值:false
*/
Force?: boolean;
}
/**
* CreateDBCustomNodes请求参数结构体
*/
export interface CreateDBCustomNodesRequest {
/**
* 产品支持的可用区
枚举值:
- ap-shanghai-5: 上海五区
- ap-shanghai-8: 上海八区
- ap-nanjing-3: 南京三区
*/
Zone: string;
/**
* 镜像ID
参数格式:img-xxxxxxx
入参限制:必须为当前账号下DB Custom 产品拥有的镜像
取值参考:可通过"DescribeDBCustomImages"接口获取支持的镜像。
*/
ImageId: string;
/**
* 为节点打通SSH连接的VPC 网络ID。
参数格式:vpc-b4zgtest
入参限制:必须是当前账号下拥有的VPC 网络ID,且不能跨地域。
取值参考:可通过【查询VPC列表】接口获取:https://cloud.tencent.com/document/product/215/15778
*/
VpcId: string;
/**
* 为节点打通SSH连接的VPC 子网 ID。
参数格式:subnet-t13dtest
入参限制:必须是VPC之下的子网,子网必须与可用区对应。
取值参考:可通过【查询子网列表】接口获取:https://cloud.tencent.com/document/product/215/15784
*/
SubnetId: string;
/**
* 节点机型
枚举值:
- DB.AT5.32XLARGE512: 高IO型服务器:128核心512GB内存,8*7180GB本地NvME SSDB。
- DB.AT5.64XLARGE1152: 高IO型服务器:256核心1152GB内存,12*7180GB本地NvME SSDB。
- DB.AT5.128XLARGE2304: 高IO型服务器:512核心2304GB内存,24*7180GB本地NvME SSDB。
- DB.AT5.16XLARGE256: 高IO型服务器:64核心256GB内存,4*7180GB本地NvME SSDB。
- DB.AT5.8XLARGE128: 高IO型服务器:32核心128GB内存,2*7180GB本地NvME SSDB。
*/
NodeType: string;
/**
* 购买的节点数量
取值范围:[1, 20]
*/
NodeCount: number;
/**
* 节点登录设置。通过该参数可以设置节点的登录方式密码、密钥或保持镜像的原始登录设置。
入参限制:若选择密钥方式,KeyIds 仅支持单个 ID。三种方式必须且仅可以设置其中一种。
*/
LoginSettings: LoginSettings;
/**
* 购买时长(月): 1/2/3/4/5/6/7/8/9/10/11/12/24/36
取值范围:[1, 36]
单位:月
默认值:1
*/
Period?: number;
/**
* 自动续费配置
枚举值:
默认值:不自动续费
*/
AutoRenew?: number;
/**
* 节点名称
入参限制:最多128个字符
*/
NodeName?: string;
/**
* 是否使用代金券自动抵扣
枚举值:
默认值:0
*/
AutoVoucher?: number;
/**
* 代金券ID
入参限制:必须为当前账号下拥有的未抵扣的代金券ID。
*/
VoucherIds?: Array;
/**
* 标签
*/
Tags?: Array;
/**
* 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/
ClientToken?: string;
/**
* 计费模式
枚举值:
- PREPAID: 包年包月
- POSTPAID: 按量付费
默认值:默认为包年包月(PREPAID)
*/
ChargeType?: string;
/**
* 访问主机的网络模式
枚举值:
- privatelink: 四层网络联通,放通SSH 通路
- cross_tenant_eni: 三层网络联通,双网卡模式
默认值:默认值为:privatelink
*/
NetworkMode?: string;
/**
* 系统盘配置
入参限制:仅云盘版机型支持,如DB.SA5机型。本地盘机型DB.AT5机型不支持设置
*/
SystemDisk?: SystemDisk;
/**
* 数据库盘配置
入参限制:仅云盘版机型支持,如DB.SA5机型。本地盘机型DB.AT5机型不支持设置
*/
DataDisks?: Array;
/**
* 主机的hostname。
参数格式:字符串或者指定模式串
入参限制:- 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。不允许使用下划线(_)。
- Windows 节点:主机名名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
- 其他类型(Linux 等)节点:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
- 购买多台节点时:
- 指定模式串 {R:x}:表示生成数字序列 [x, x+n-1],其中 n为购买节点的数量。例如:输入 server_{R:3},购买1台时,节点主机名为 server_3;购买2台时,主机名分别为 server_3、server_4。
- 指定模式串 {R:x,F:y}:y表示固定位数(可选),取值范围为 [0,8],默认值 0表示不固定位数(等效于 {R:x})。不足位时自动补零,例如:输入server_{R:3,F:3},购买2台时,节点主机名为 server_003、server_004。若数字位数超过 y(如 {R:99,F:2}),以实际位数为准,例如:app_{R:99,F:2},购买2台时,节点主机名为 app_99、app_100。
- 指定模式串 {IP}:自动替换为节点的内网IP地址。例如:输入 node-{IP},节点主机名为 node-10.0.12.8;支持与序号模式串混合使用,例如:输入 web-{IP}-{R:1},购买2台时,节点主机名分别为 web-10.0.12.8-1、web-10.0.12.9-2。
- 模式串需严格遵循 {R:x,F:y}、{R:x} 或 {IP} 格式,无效格式(如 {})视为普通文本。支持多个模式串。
- 未指定模式串:节点主机名添加后缀 1、2...n,其中n表示购买节点的数量,例如 server_购买2台时生成 server_1、server_2。
*/
HostName?: string;
/**
* 试运行开关。
枚举值:
- true: 为 true 时接口只执行参数校验与资源申请检查(库存、配额、网络等),完成后立即返回空响应,不会真正下单,也不会创建节点记录。用于调用方在真正下单前做一次可行性预检。
- false: 不预检查
默认值:false
*/
DryRun?: boolean;
/**
* 设置节点安全组
参数格式:设置需要与节点绑定的多个安全组ID,以数组形式配置。
*/
SecurityGroupIds?: Array;
/**
* 置放群组ID
入参限制:仅支持指定一个
*/
DisasterRecoverGroupIds?: Array;
}
/**
* RenewDBCustomNode返回参数结构体
*/
export interface RenewDBCustomNodeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBCustomImages返回参数结构体
*/
export interface DescribeDBCustomImagesResponse {
/**
* 总镜像数量
*/
TotalCount?: number;
/**
* 支持的镜像列表信息
*/
ImageSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBCustomNodeTags返回参数结构体
*/
export interface ModifyDBCustomNodeTagsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群扩展信息。
*/
export interface InstanceExpand {
/**
* 集群ID
*/
InstanceId?: string;
/**
* 集群名称
*/
InstanceName?: string;
/**
* 用户ID
*/
AppId?: number;
/**
* 地域
*/
Region?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 集群类型: 0:一主一备,1:一主两备
*/
InstanceType?: number;
/**
* 集群状态: 0 集群创建中, 1 集群有效, 2 集群扩容中, 3 集群删除中, 4 集群缩容中 -1 集群已隔离 -2 集群已删除
*/
InstanceStatus?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 实例自动续费标识: 0正常续费 1自动续费 2到期不续费
*/
AutoRenewFlag?: number;
/**
* 机型
*/
Machine?: string;
/**
* 过期时间
*/
PeriodEndTime?: string;
/**
* 集群信息
*/
InstanceDetail?: InstanceDetail;
/**
* 计费侧的产品ID
*/
Pid?: number;
}
/**
* AddNodesToDBCustomCluster返回参数结构体
*/
export interface AddNodesToDBCustomClusterResponse {
/**
* 上架节点的任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyDBCustomCluster返回参数结构体
*/
export interface DestroyDBCustomClusterResponse {
/**
* 销毁集群的任务ID
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBCustomClusterNodeResources请求参数结构体
*/
export interface DescribeDBCustomClusterNodeResourcesRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 按照一个或者多个 NodeId 查询。
入参限制:每次请求的数量上限为50
*/
NodeIds: Array;
}
/**
* 标签对象,包含tagKey & tagValue
*/
export interface ResourceTag {
/**
* 标签键
*/
TagKey: string;
/**
* 标签值
*/
TagValue: string;
}
/**
* DB Custom 节点数据盘信息。
*/
export interface DataDisk {
/**
* 磁盘类型
枚举值:
- CLOUD_HSSD: 增强型云硬盘
- LOCAL_NVME: 本地硬盘
*/
DiskType: string;
/**
* 磁盘大小
单位:GiB
*/
DiskSize: number;
/**
* 磁盘名称
DataDisk 作为输入参数时,DiskName 无效。
*/
DiskName?: string;
}
/**
* ModifyDBCustomNodesDisasterRecoverGroup返回参数结构体
*/
export interface ModifyDBCustomNodesDisasterRecoverGroupResponse {
/**
* 任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBCustomClusterAttributes请求参数结构体
*/
export interface ModifyDBCustomClusterAttributesRequest {
/**
* 集群ID
参数格式:dbcc-hj7gab15
*/
ClusterId: string;
/**
* 是否启用集群删除保护
枚举值:
*/
DeletionProtection?: boolean;
}
/**
* DescribeDBCustomNodeTypes请求参数结构体
*/
export interface DescribeDBCustomNodeTypesRequest {
/**
* 支持通过地域,可用区,机型系列,机型标识进行过滤
入参限制:region、zone、node-family、node-type
*/
Filters?: Array;
}
/**
* DB Custom 节点登录相关配置。
*/
export interface LoginSettings {
/**
* 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下: Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。 Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。
*/
Password?: string;
/**
* 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口 DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。
入参限制:当前仅支持设置单个 ID。
*/
KeyIds?: Array;
/**
* 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。
枚举值:
- true: 表示保持镜像的登录设置
- false: 表示不保持镜像的登录设置
*/
KeepImageLogin?: string;
}
/**
* 安全组详情
*/
export interface SecurityGroup {
/**
* 安全组ID
*/
SecurityGroupId?: string;
/**
* 所属项目 ID
*/
ProjectId?: number;
/**
* 安全组创建时间
*/
CreateTime?: string;
/**
* 安全组入方向规则列表
*/
Inbound?: Array;
/**
* 安全组出方向规则列表
*/
Outbound?: Array;
/**
* 安全组名称
*/
SecurityGroupName?: string;
/**
* 安全组备注说明
*/
SecurityGroupRemark?: string;
}
/**
* DB Custom 可选的镜像信息。
*/
export interface DBCustomImage {
/**
* 镜像ID
*/
ImageId?: string;
/**
* 操作系统名称
*/
OsName?: string;
/**
* 镜像类型
枚举值:
- PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)
- PRIVATE_IMAGE: 私有镜像 (客户专属镜像)
*/
ImageType?: string;
/**
* 操作系统架构
枚举值:
- x86_64: X86 64位架构
- arm64: ARM 64位机构
*/
Architecture?: string;
/**
* 操作系统类型
枚举值:
- windows: windows
- linux: linux
*/
OsType?: string;
}
/**
* DescribeDBCustomClusterNodeResources返回参数结构体
*/
export interface DescribeDBCustomClusterNodeResourcesResponse {
/**
* 当前账号下拥有的DB Custom 节点列表信息
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDBCustomClusterTags返回参数结构体
*/
export interface ModifyDBCustomClusterTagsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDBCustomRegions返回参数结构体
*/
export interface DescribeDBCustomRegionsResponse {
/**
* 支持售卖的地域列表信息
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 独享集群详情
*/
export interface DescribeInstanceDetail {
/**
* 独享集群实例Id
*/
InstanceId?: string;
/**
* 独享集群实例名称
*/
InstanceName?: string;
/**
* 地域
*/
Region?: string;
/**
* 产品ID, 0:CDB, 1:TDSQL
*/
ProductId?: number;
/**
* 集群类型, 0:公有云, 1:金融围笼, 2:CDC集群
*/
Type?: number;
/**
* 主机类型, 0:物理机, 1:CVM机型, 2:CDC机型
*/
HostType?: number;
/**
* 自动续费标志, 0:未设置, 1:自动续费, 2:到期不续费
*/
AutoRenewFlag?: number;
/**
* 集群状态
*/
Status?: number;
/**
* 集群状态描述
*/
StatusDesc?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 到期时间
*/
PeriodEndTime?: string;
/**
* 主机数
*/
HostNum?: number;
/**
* DB实例数
*/
DbNum?: number;
/**
* 分配策略, 0:紧凑, 1:均匀
*/
AssignStrategy?: number;
/**
* 总主机CPU(单位:核数)
*/
CpuSpec?: number;
/**
* 总已分配CPU(单位:核数)
*/
CpuAssigned?: number;
/**
* 总可分配CPU(单位:核数)
*/
CpuAssignable?: number;
/**
* 总主机内存(单位:GB)
*/
MemorySpec?: number;
/**
* 总已分配内存(单位:GB)
*/
MemoryAssigned?: number;
/**
* 总可分配内存(单位:GB)
*/
MemoryAssignable?: number;
/**
* 总机器磁盘(单位:GB)
*/
DiskSpec?: number;
/**
* 总已分配磁盘(单位:GB)
*/
DiskAssigned?: number;
/**
* 总可分配磁盘(单位:GB)
*/
DiskAssignable?: number;
/**
* 可用区
*/
Zone?: string;
/**
* 金融围笼ID
*/
FenceId?: string;
/**
* 所属集群ID(默认集群为空)
*/
ClusterId?: string;
/**
* 实例标签
*/
ResourceTags?: Array;
/**
* CPU类型:Intel/AMD,Hygon
*/
CpuType?: string;
/**
* 可用区列表
*/
Zones?: Array;
}
/**
* 集群设备组信息。
*/
export interface InstanceDeviceInfo {
/**
* 集群ID
*/
InstanceId?: string;
/**
* 读写设备组
*/
ReadWriteDevice?: Array;
/**
* 只读设备组
*/
ReadOnlyDevice?: Array;
/**
* 空闲设备组
*/
FreeDevice?: Array;
}
/**
* DescribeDBCustomClusterKubeconfig请求参数结构体
*/
export interface DescribeDBCustomClusterKubeconfigRequest {
/**
* 集群ID
入参限制:必须为当前节点拥有的DB Custom 集群
*/
ClusterId: string;
}
/**
* DescribeDBCustomDisasterRecoverGroups返回参数结构体
*/
export interface DescribeDBCustomDisasterRecoverGroupsResponse {
/**
* 总数
*/
TotalCount?: number;
/**
* 置放群组列表
注意:此字段可能返回 null,表示取不到有效值。
*/
DisasterRecoverGroupSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveNodesFromDBCustomCluster请求参数结构体
*/
export interface RemoveNodesFromDBCustomClusterRequest {
/**
* DB Custom 集群ID
*/
ClusterId: string;
/**
* 要下架的 DB Custom 节点ID列表
*/
NodeIds: Array;
/**
* 节点的登录参数
*/
LoginSettings?: LoginSettings;
/**
* 当节点中还有业务 Pod 在运行,默认会拦截从集群中移除节点的操作。如果该参数为 true,表示强制执行此操作。
枚举值:
默认值:false
*/
Force?: boolean;
}
/**
* DescribeDBCustomClusters返回参数结构体
*/
export interface DescribeDBCustomClustersResponse {
/**
* 总集群数量
*/
TotalCount?: number;
/**
* 集群列表信息
*/
ClusterSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDBCustomNodesDisasterRecoverGroup请求参数结构体
*/
export interface DeleteDBCustomNodesDisasterRecoverGroupRequest {
/**
* 节点ID
入参限制:单次数量上限为100
*/
NodeIds: Array;
/**
* 置放群组ID
入参限制:只支持传一个ID
*/
DisasterRecoverGroupIds: Array;
}
/**
* CheckRoleAuthorized返回参数结构体
*/
export interface CheckRoleAuthorizedResponse {
/**
* 角色权限状态
枚举值:
- AUTHORIZED: 已经创建授权
- NEED_GRANT: 未授权
- ERROR: 报错
*/
Status?: string;
/**
* 出错的错误信息
*/
Message?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstances请求参数结构体
*/
export interface DescribeInstancesRequest {
/**
* 集群类型: 0 一主一备, 1 一主两备...N-1 一主N备
*/
InstanceTypes?: Array;
/**
* 产品ID: 0 MYSQL,1 TDSQL
*/
ProductIds?: Array;
/**
* 集群uuid: 如 dbdc-q810131s
*/
InstanceIds?: Array;
/**
* 是否按金融围笼标志搜索
*/
FenceFlag?: boolean;
/**
* 按实例名字模糊匹配
*/
InstanceName?: string;
/**
* 每页数目, 整型
*/
PageSize?: number;
/**
* 页码, 整型
*/
PageNumber?: number;
/**
* 排序字段,枚举:createtime,groupname
*/
OrderBy?: string;
/**
* 排序方式: asc升序, desc降序
*/
OrderByType?: string;
/**
* 集群状态: -2 已删除, -1 已隔离, 0 创建中, 1 运行中, 2 扩容中, 3 删除中
*/
InstanceStatus?: number;
}
/**
* DescribeDBCustomClusterDetail请求参数结构体
*/
export interface DescribeDBCustomClusterDetailRequest {
/**
* DB Custom 集群ID
入参限制:必须为此账号拥有的DB Custom集群
*/
ClusterId: string;
}
/**
* RenewDBCustomNode请求参数结构体
*/
export interface RenewDBCustomNodeRequest {
/**
* 节点ID
*/
NodeId: string;
/**
* 续费周期
取值范围:[1, 36]
单位:月
默认值:1
*/
Period?: number;
/**
* 是否开启自动续费
枚举值:
默认值:1
*/
AutoRenew?: number;
/**
* 是否自动使用代金券
*/
AutoVoucher?: number;
/**
* 代金券ID
*/
VoucherIds?: Array;
}
/**
* 描述键值对过滤器,用于条件过滤查询。
*/
export interface Filter {
/**
* 筛选条件
*/
Name: string;
/**
* 过滤字段对应的参数值
*/
Values: Array;
}
/**
* IsolateDBCustomNode返回参数结构体
*/
export interface IsolateDBCustomNodeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DB Custom 集群内节点配置信息。
*/
export interface DBCustomClusterNodeConfig {
/**
* 节点ID
*/
NodeId?: string;
/**
* 节点的标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Labels?: Array