/** * IsolateDBCustomNode请求参数结构体 */ export interface IsolateDBCustomNodeRequest { /** *

DB Custom 节点ID

*/ NodeId: string; } /** * DescribeDBCustomDisasterRecoverGroupQuota请求参数结构体 */ export type DescribeDBCustomDisasterRecoverGroupQuotaRequest = null; /** * DescribeDBCustomClusterDetail返回参数结构体 */ export interface DescribeDBCustomClusterDetailResponse { /** *

集群ID

*/ ClusterId?: string; /** *

集群名称

*/ ClusterName?: string; /** *

集群描述

*/ ClusterDescription?: string; /** *

集群所属地域

枚举值:

*/ Region?: string; /** *

DB Custom 集群状态

枚举值:

*/ ClusterStatus?: string; /** *

集群版本

枚举值:

默认值:1.34.1

*/ ClusterVersion?: string; /** *

集群下的节点数量

*/ ClusterNodeNum?: number; /** *

集群规模

*/ ClusterLevel?: string; /** *

创建时间

*/ CreatedTime?: string; /** *

集群标签信息

注意:此字段可能返回 null,表示取不到有效值。 */ Tags?: Array; /** *

集群的API Server的网络信息

注意:此字段可能返回 null,表示取不到有效值。 */ ApiServerNetwork?: ApiServerNetwork; /** *

容器网络,在此集群中的所有Pod将与此网络连通

注意:此字段可能返回 null,表示取不到有效值。 */ ContainerNetwork?: ContainerNetwork; /** *

是否启用集群删除保护

枚举值:

*/ DeletionProtection?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyDBCustomCluster请求参数结构体 */ export interface DestroyDBCustomClusterRequest { /** *

待销毁的集群ID

入参限制:待销毁的集群必须无任何节点在此集群中。

*/ ClusterId: string; } /** * DescribeDBCustomClusterResources请求参数结构体 */ export interface DescribeDBCustomClusterResourcesRequest { /** *

集群ID

*/ ClusterId: string; } /** * ModifyInstanceName请求参数结构体 */ export interface ModifyInstanceNameRequest { /** * 独享集群实例Id */ InstanceId: string; /** * 独享集群实例名称 */ InstanceName?: string; } /** * DescribeDBCustomClusterNodeConfig返回参数结构体 */ export interface DescribeDBCustomClusterNodeConfigResponse { /** *

当前账号下拥有的DB Custom 节点列表信息

*/ NodeSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstances返回参数结构体 */ export interface DescribeInstancesResponse { /** * 集群数量 */ TotalCount?: number; /** * 集群扩展信息 */ Instances?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDBCustomDisasterRecoverGroups返回参数结构体 */ export interface DeleteDBCustomDisasterRecoverGroupsResponse { /** *

任务ID

注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DB Custom 节点系统盘信息。 */ export interface SystemDisk { /** *

磁盘类型

枚举值:

  • CLOUD_HSSD: 增强型云硬盘
*/ DiskType: string; /** *

磁盘大小

单位:GiB

*/ DiskSize: number; } /** * DB Custom 节点机型信息。 */ export interface DBCustomNodeTypeInfo { /** *

可用区标识,如 ap-guangzhou-6

*/ Zone?: string; /** *

机型标识

枚举值:

  • DB.SA5.2XLARGE32: DB.SA5机型
  • DB.AT5.8XLARGE128: DB.AT5机型
*/ NodeType?: string; /** *

机型系列,如 DB.AT5、DB.SA5

*/ NodeFamily?: string; /** *

CPU 核数

单位:核

*/ CPU?: number; /** *

内存大小

单位:GiB

*/ Memory?: number; /** *

机型售卖状态

枚举值:

  • SELL: 正常售卖
  • SOLD_OUT: 售罄
*/ Status?: string; /** *

该机型允许的系统盘类型列表(如 CLOUD_BSSD、CLOUD_HSSD);

*/ SystemDiskTypes?: Array; /** *

该机型允许的数据盘类型列表(如 CLOUD_BSSD、CLOUD_HSSD);

*/ DataDiskTypes?: Array; } /** * ModifyInstanceName返回参数结构体 */ export interface ModifyInstanceNameResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBCustomClusterNodeConfig请求参数结构体 */ export interface DescribeDBCustomClusterNodeConfigRequest { /** *

集群ID

*/ ClusterId: string; /** *

按照一个或者多个 NodeId 查询。

入参限制:每次请求的数量上限为100

*/ NodeIds: Array; } /** * DescribeDBCustomDisasterRecoverGroupQuota返回参数结构体 */ export interface DescribeDBCustomDisasterRecoverGroupQuotaResponse { /** *

可创建置放群组数量的上限

*/ GroupQuota?: number; /** *

已经创建的置放群组数量

*/ CurrentNum?: number; /** *

物理机类型置放群组内节点的配额数

*/ NodeInHostGroupQuota?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBCustomNodeAttributes返回参数结构体 */ export interface ModifyDBCustomNodeAttributesResponse { /** *

上架节点的任务ID

注意:此字段可能返回 null,表示取不到有效值。 */ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDBCustomCluster返回参数结构体 */ export interface CreateDBCustomClusterResponse { /** *

本次创建的集群ID

*/ ClusterId?: string; /** *

本次创建集群的任务ID

*/ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBCustomImages请求参数结构体 */ export interface DescribeDBCustomImagesRequest { /** *

支持镜像过滤的选项

取值参考:

  • image-id,按镜像 ID 过滤
  • os-type,按操作系统类型过滤(linux / windows)
  • image-type,按镜像类型过滤(PUBLIC_IMAGE(公共镜像)/ PRIVATE_IMAGE(私有镜像))
  • architecture,按架构过滤(x86_64 / arm64)
*/ Filters?: Array; /** *

偏移量

默认值:0

*/ Offset?: number; /** *

返回数量

取值范围:[1, 100]

默认值:20

*/ Limit?: number; } /** * 可用区信息。 */ export interface ZoneInfo { /** *

支持的可用区

*/ Zone?: string; /** *

可用区状态

枚举值:

  • SELL: 正常售卖
  • SOLD_OUT: 售罄
*/ ZoneState?: string; } /** * 标签键值对。 */ export interface Tag { /** *

标签键

*/ Key: string; /** *

标签值

*/ Value: string; } /** * DB Custom 集群内节点资源信息。 */ export interface DBCustomClusterNodeResource { /** *

节点ID

*/ NodeId?: string; /** *

节点物理资源总容量

注意:此字段可能返回 null,表示取不到有效值。 */ Capacity?: MetaResource; /** *

节点可分配容量= Capacity - 系统预留

注意:此字段可能返回 null,表示取不到有效值。 */ Allocatable?: MetaResource; /** *

节点上所有非终态 Pod 的 requests 申请量之和(含系统 Pod)

注意:此字段可能返回 null,表示取不到有效值。 */ Requests?: MetaResource; /** *

节点上所有非终态 Pod 的 limits 上限之和(含系统 Pod)

注意:此字段可能返回 null,表示取不到有效值。 */ Limits?: MetaResource; /** *

节点可再调度余量 = max(0, Allocatable - Requests)

注意:此字段可能返回 null,表示取不到有效值。 */ Available?: MetaResource; } /** * CreateDBCustomCluster请求参数结构体 */ export interface CreateDBCustomClusterRequest { /** *

容器网络,在此集群的所有 POD 与此网络连通

*/ ContainerNetwork: ContainerNetwork; /** *

集群名称

入参限制:最长128个字符。

*/ ClusterName?: string; /** *

集群的API Server的网络信息

入参限制:必须为此账号下拥有的网络地址,可以与容器网络保持一致。

*/ ApiServerNetwork?: ApiServerNetwork; /** *

集群描述

*/ ClusterDescription?: string; /** *

集群标签

*/ Tags?: Array; /** *

客户端Token

*/ ClientToken?: string; /** *

试运行开关,true 时只执行参数校验,不发起创建流程,默认 false

*/ DryRun?: boolean; /** *

是否启用集群删除保护

枚举值:

  • true: 启用
  • false: 不启用

默认值:true

*/ DeletionProtection?: boolean; } /** * DescribeInstanceList返回参数结构体 */ export interface DescribeInstanceListResponse { /** * 独享集群列表 */ Instances?: Array; /** * 独享集群实例总数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBCustomDisasterRecoverGroups请求参数结构体 */ export interface DescribeDBCustomDisasterRecoverGroupsRequest { /** *

置放群组ID

入参限制:单次数量上限是10

*/ DisasterRecoverGroupIds?: Array; /** *

查询筛选条件。支持的筛选条件包括:

  • tag-key:按标签键进行过滤。
  • tag-value:按标签值进行过滤。

入参限制:数量上限为5

*/ Filters?: Array; /** *

根据标签键和标签值筛选 DB Custom 置放群组

入参限制:数量上限为5

*/ Tags?: Array; /** *

分页偏移量

*/ Offset?: number; /** *

返回数量

取值范围:[1, 100]

默认值:20

*/ Limit?: number; } /** * ModifyDBCustomNodeSecurityGroups返回参数结构体 */ export interface ModifyDBCustomNodeSecurityGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标签信息。 */ export interface Label { /** *

在集群内的节点Label键

*/ Key?: string; /** *

在集群内的节点Label键值

*/ Value?: string; } /** * RemoveNodesFromDBCustomCluster返回参数结构体 */ export interface RemoveNodesFromDBCustomClusterResponse { /** *

任务ID

*/ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBCustomNodes返回参数结构体 */ export interface DescribeDBCustomNodesResponse { /** *

当前账号下拥有的DB Custom 节点总数

*/ TotalCount?: number; /** *

当前账号下拥有的DB Custom 节点列表信息

*/ NodeSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBCustomClusterResources返回参数结构体 */ export interface DescribeDBCustomClusterResourcesResponse { /** *

参与汇总的工作节点总数(不含控制面节点)

单位:台

*/ NodeCount?: number; /** *

集群所有节点的资源物理总容量之和

*/ Capacity?: MetaResource; /** *

集群所有节点的可分配容量之和(= Capacity - 系统预留)

*/ Allocatable?: MetaResource; /** *

集群所有非终态 Pod 的 requests 申请量之和(含系统 Pod)

*/ Requests?: MetaResource; /** *

集群所有非终态 Pod 的 limits 上限之和(含系统 Pod,Pods 字段无语义,固定为 0)

*/ Limits?: MetaResource; /** *

集群可再调度余量(所有节点 max(0, Allocatable - Requests) 累加求和)

*/ Available?: MetaResource; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBCustomDisasterRecoverGroupTags返回参数结构体 */ export interface ModifyDBCustomDisasterRecoverGroupTagsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBCustomClusterNodes请求参数结构体 */ export interface DescribeDBCustomClusterNodesRequest { /** *

DB Custom 集群ID

*/ ClusterId: string; /** *

查询筛选条件。支持的条件有:

  • node-name:DB Custom 节点名称。
*/ Filters?: Array; /** *

分页偏移量

*/ Offset?: number; /** *

返回数量

取值范围:[1, 100]

默认值:20

*/ Limit?: number; } /** * DescribeInstanceList请求参数结构体 */ export interface DescribeInstanceListRequest { /** * 分页返回数量 */ Limit?: number; /** * 分页偏移量 */ Offset?: number; /** * 排序字段,createTime,instancename两者之一 */ OrderBy?: string; /** * 排序规则,desc,asc两者之一 */ SortBy?: string; /** * 按产品过滤,0:CDB, 1:TDSQL */ ProductId?: Array; /** * 按实例ID过滤 */ InstanceId?: Array; /** * 按实例名称过滤 */ InstanceName?: Array; /** * 按金融围笼ID过滤 */ FenceId?: Array; /** * 按实例状态过滤, -1:已隔离, 0:创建中, 1:运行中, 2:扩容中, 3:删除中 */ Status?: Array; /** * 按所属集群ID过滤 */ ClusterId?: Array; } /** * DescribeDBCustomClusters请求参数结构体 */ export interface DescribeDBCustomClustersRequest { /** *

按照一个或者多个 ClusterId 查询。

入参限制:每次请求的数量上限为100

*/ ClusterIds?: Array; /** *

查询筛选条件。支持的筛选条件包括:

  • cluster-name:DB Custom 集群名称,精确匹配。
  • cluster-status:DB Custom 集群状态(Creating,Running,Destroying)。
*/ Filters?: Array; /** *

根据标签的 Key 和 Value 筛选 DB Custom 集群

*/ Tags?: Array; /** *

集群列表分页偏移量

*/ Offset?: number; /** *

返回数量

取值范围:[1, 100]

默认值:20

*/ Limit?: number; } /** * DescribeDBInstances请求参数结构体 */ export interface DescribeDBInstancesRequest { /** * 独享集群实例Id */ InstanceId: string; /** * 独享集群主机Id */ HostId?: string; /** * 分页返回数量 */ Limit?: number; /** * 分页偏移量 */ Offset?: number; /** * 实例类型,0:mariadb, 1:tdsql */ ShardType?: Array; } /** * DescribeDBCustomNodeTypes返回参数结构体 */ export interface DescribeDBCustomNodeTypesResponse { /** *

节点机型详细信息

注意:此字段可能返回 null,表示取不到有效值。 */ NodeTypeSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddNodesToDBCustomCluster请求参数结构体 */ export interface AddNodesToDBCustomClusterRequest { /** *

集群ID

*/ ClusterId: string; /** *

需上架的节点 ID 列表

*/ NodeIds: Array; /** *

节点上架后重设的操作系统镜像ID

取值参考:可通过"DescribeDBCustomImages"接口获取支持的镜像。

*/ ImageId: string; /** *

实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。

入参限制:若选择密钥方式,KeyIds 仅支持单个 ID。三种方式必须且仅可以设置其中一种。

*/ LoginSettings: LoginSettings; /** *

节点上架成功后初始化新增的自定义 Label

入参限制:单次 ≤ 20 对

*/ Labels?: Array