Class TaiyiConnector

提供与Taiyi Control服务进行交互的方法，包括认证、发送命令、查询访问记录等,系统状态查询与初始化接口可以直接调用，其他接口需要先认证才能调用。调用者需要实现 SetTokenHandler 和 GetTokenHandler，为 TaiyiConnector 提供令牌的存取能力。如果需要在校验信息失效时，进行特殊处理，可以通过可选的 bindAuthExpiredEvent 方法注册回调。

Example

...
//构建 TaiyiConnector 实例
const connector = new TaiyiConnector(backendHost, backendPort, deviceID);
//绑定令牌存取回调
connector.bindCallback(store.id, storeAllocatedTokens, retrieveAllocatedTokens, handleStoreStatusChanged);
//可选：绑定校验过期回调
connector.bindAuthExpiredEvent(handleAuthExpired);
const authResult = await connector.authenticateByToken(token);
if (authResult.unauthenticated) {
  throw new Error("校验失败");
} else if (authResult.error) {
  //其他错误
  throw new Error(authResult.error);
}
const tokens = authResult.data;
console.log("令牌校验成功,当前用户 %s, 角色 %s", tokens.user, tokens.roles);
//从第13个记录开始，查询10条记录
const result = await connector.queryGuests(13, 10);
if (result.error) {
  throw new Error(result.error);
}
//PaginationResult
const data = result.data;
console.log(
  "返回结果 %s, 总记录数 %d",
  JSON.stringify(data.records),
  data.total
);

Index

Constructors

constructor

new TaiyiConnector(
    backendHost: string,
    backendPort?: number,
    device: string,
): TaiyiConnector
构造函数
Parameters
- backendHost: string
  后端Control服务地址
- backendPort: number = 5851
  后端Control服务端口，默认值为5851
- device: string
  设备标识
Returns TaiyiConnector
- Defined in connector.ts:178

Accessors

authenticated

get authenticated(): boolean
获取认证状态

Returns boolean
认证状态
- Defined in connector.ts:201

id

get id(): string
获取连接标识

Returns string
连接标识
- Defined in connector.ts:194

roles

get roles(): UserRole[]
获取用户角色

Returns UserRole[]
用户角色
- Defined in connector.ts:215

user

get user(): string
获取用户标识

Returns string
用户标识
- Defined in connector.ts:208

Methods

activateLicense

activateLicense(licenseID: string): Promise<BackendResult<void>>
激活许可证
Parameters
- licenseID: string
  许可证ID
Returns Promise<BackendResult<void>>
激活结果
- Defined in connector.ts:4223

addAddressPool

addAddressPool(
    id: string,
    mode: InterfaceMode,
    isV6: boolean,
    description?: string,
): Promise<BackendResult<void>>
添加地址池
Parameters
- id: string
  地址池ID
- mode: InterfaceMode
  接口模式
- isV6: boolean
  是否为IPv6
- Optionaldescription: string
  描述
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2489

addComputeNode

addComputeNode(poolID: string, nodeID: string): Promise<BackendResult<void>>
添加计算节点到资源池
Parameters
- poolID: string
  资源池ID
- nodeID: string
  节点ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2098

addComputePool

addComputePool(config: ComputePoolConfig): Promise<BackendResult<void>>
添加计算资源池
Parameters
- config: ComputePoolConfig
  计算资源池配置
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2054

addExternalAddressRange

addExternalAddressRange(
    poolID: string,
    beginAddress: string,
    endAddress: string,
): Promise<BackendResult<void>>
添加外部地址范围
Parameters
- poolID: string
  地址池ID
- beginAddress: string
  起始地址
- endAddress: string
  结束地址
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2553

addExternalInterface

addExternalInterface(
    guestID: string,
    macAddress: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
添加外部接口
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:1618

addGroup

addGroup(group: UserGroup): Promise<BackendResult<void>>
添加用户组
Parameters
- group: UserGroup
  用户组
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:4859

addImportSource

addImportSource(
    vendor: VMWareESXi,
    url: string,
    token: string,
    secret: string,
): Promise<BackendResult<void>>
添加导入源
Parameters
- vendor: VMWareESXi
  供应商类型
- url: string
  导入源URL
- token: string
  认证token
- secret: string
  认证secret
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:4453

addInternalAddressRange

addInternalAddressRange(
    poolID: string,
    beginAddress: string,
    endAddress: string,
): Promise<BackendResult<void>>
添加内部地址范围
Parameters
- poolID: string
  地址池ID
- beginAddress: string
  起始地址
- endAddress: string
  结束地址
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2577

addInternalInterface

addInternalInterface(
    guestID: string,
    macAddress: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
添加内部接口
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:1741

addLicense

addLicense(license: License): Promise<BackendResult<void>>
添加许可证
Parameters
- license: License
  许可证信息
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:4238

addNode

addNode(config: ClusterNode): Promise<BackendResult<void>>
添加节点
Parameters
- config: ClusterNode
  节点配置
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:1920

addRemoteContainer

addRemoteContainer(
    poolID: string,
    container: VolumeContainer,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
添加远程容器
Parameters
- poolID: string
  存储池ID
- container: VolumeContainer
  容器配置
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2294

addResourceContainer

addResourceContainer(
    nodeID: string,
    poolID: string,
    container: VolumeContainer,
): Promise<BackendResult<void>>
添加节点本地存储池容器
Parameters
- nodeID: string
  节点ID
- poolID: string
  池ID
- container: VolumeContainer
  容器配置
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:3233

addSSHKey

addSSHKey(
    label: string,
    content: string,
    access_level: ResourceAccessLevel,
): Promise<BackendResult<void>>
添加SSH密钥
Parameters
- label: string
  标签
- content: string
  密钥内容
- access_level: ResourceAccessLevel
  资源访问级别
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:4134

addStoragePool

addStoragePool(config: StoragePoolConfig): Promise<BackendResult<void>>
添加存储池
Parameters
- config: StoragePoolConfig
  存储池配置
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2194

addSystem

addSystem(
    label: string,
    spec: GuestSystemSpec,
    access_level: ResourceAccessLevel,
): Promise<BackendResult<void>>
添加系统模板
Parameters
- label: string
  标签
- spec: GuestSystemSpec
  系统规格
- access_level: ResourceAccessLevel
  资源访问级别
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:3780

addUser

addUser(
    user: string,
    group: string,
    password: string,
): Promise<BackendResult<void>>
添加用户
Parameters
- user: string
  用户名
- group: string
  用户组
- password: string
  密码
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:4923

addVolume

addVolume(
    guestID: string,
    volume: VolumeSpec,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
添加卷
Parameters
- guestID: string
  云主机ID
- volume: VolumeSpec
  磁盘卷配置
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:1154

addWhiteList

addWhiteList(address: string): Promise<BackendResult<void>>
添加白名单
Parameters
- address: string
  白名单地址
Returns Promise<BackendResult<void>>
添加结果
- Defined in connector.ts:5173

authenticateByPassword

authenticateByPassword(
user: string,
password: string,
): Promise<BackendResult<AllocatedTokens>>
密码认证
Parameters
- user: string
  用户标识
- password: string
  密码
Returns Promise<BackendResult<AllocatedTokens>>
已认证令牌
- Defined in connector.ts:259

authenticateByToken

authenticateByToken(token: string): Promise<BackendResult<AllocatedTokens>>
使用秘钥字符串校验
Parameters
- token: string
  秘钥字符串
Returns Promise<BackendResult<AllocatedTokens>>
已认证令牌
- Defined in connector.ts:302

bindAuthExpiredEvent

bindAuthExpiredEvent(callback: AuthExpiredEvent): void
绑定认证过期事件
Parameters
- callback: AuthExpiredEvent
  认证过期事件回调
Returns void
- Defined in connector.ts:242

bindCallback

bindCallback(
    receiver: string,
    setter: SetTokenHandler,
    getter: GetTokenHandler,
    stateChange?: StateChangeHandler,
): void
绑定令牌更新回调
Parameters
- receiver: string
  接受者标识
- setter: SetTokenHandler
  令牌更新回调
- getter: GetTokenHandler
  令牌获取回调
- OptionalstateChange: StateChangeHandler
  状态变更回调
Returns void
- Defined in connector.ts:225

changeComputePoolStrategy

changeComputePoolStrategy(
poolID: string,
strategy: ComputePoolStrategy,
): Promise<BackendResult<void>>
修改计算资源池策略
Parameters
- poolID: string
  资源池ID
- strategy: ComputePoolStrategy
  资源池策略
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2132

changeRemoteContainerFlag

changeRemoteContainerFlag(
    poolID: string,
    index: number,
    enabled: boolean,
): Promise<BackendResult<void>>
改变远程容器标志
Parameters
- poolID: string
  存储池ID
- index: number
  容器索引
- enabled: boolean
  是否启用
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2244

changeResourceContainerFlag

changeResourceContainerFlag(
    nodeID: string,
    poolID: string,
    index: number,
    enabled: boolean,
): Promise<BackendResult<void>>
更改节点本地存储池容器标志，用于启用和禁用容器
Parameters
- nodeID: string
  节点ID
- poolID: string
  池ID
- index: number
  容器索引
- enabled: boolean
  是否启用
Returns Promise<BackendResult<void>>
更改结果
- Defined in connector.ts:3306

changeUserGroup

changeUserGroup(userId: string, groupId: string): Promise<BackendResult<void>>
修改用户组
Parameters
- userId: string
  用户ID
- groupId: string
  用户组ID
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:4992

changeUserSecret

changeUserSecret(user: string, password: string): Promise<BackendResult<void>>
修改用户密码
Parameters
- user: string
  用户名
- password: string
  新密码
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:5067

clearTasks

clearTasks(): Promise<BackendResult<void>>
清除任务

Returns Promise<BackendResult<void>>
清除结果
- Defined in connector.ts:4438

clearWarnings

clearWarnings(): Promise<BackendResult<void>>
清除所有警告

Returns Promise<BackendResult<void>>
清除结果
- Defined in connector.ts:4000

couldHasMoreGuests

couldHasMoreGuests(): Promise<boolean>
检查是否可以创建更多云主机

Returns Promise<boolean>
是否可以创建更多云主机
- Defined in connector.ts:5328

couldHasMoreNodes

couldHasMoreNodes(): Promise<boolean>
检查是否可以添加更多节点

Returns Promise<boolean>
是否可以添加更多节点
- Defined in connector.ts:5350

countUnreadWarnings

countUnreadWarnings(): Promise<BackendResult<WarningStatistic>>
统计未读警告数量

Returns Promise<BackendResult<WarningStatistic>>
警告统计信息
- Defined in connector.ts:4048

countWarnings

countWarnings(nodeID: string): Promise<BackendResult<WarningStatistic>>
统计节点警告数量
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<WarningStatistic>>
警告统计信息
- Defined in connector.ts:3926

createDiskFile

createDiskFile(
spec: FileSpec,
access_level: ResourceAccessLevel,
): Promise<BackendResult<string>>
创建磁盘文件
Parameters
- spec: FileSpec
  文件规格
- access_level: ResourceAccessLevel
  资源访问级别
Returns Promise<BackendResult<string>>
文件ID
- Defined in connector.ts:2772

createGuest

createGuest(
    poolID: string,
    system: string,
    config: GuestConfig,
    timeoutSeconds?: number,
): Promise<BackendResult<string>>
创建云主机，成功返回云主机ID
Parameters
- poolID: string
  计算资源池
- system: string
  目标系统
- config: GuestConfig
  云主机配置
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<string>>
云主机ID
- Defined in connector.ts:892

createISOFile

createISOFile(
spec: FileSpec,
access_level: ResourceAccessLevel,
): Promise<BackendResult<string>>
创建ISO文件
Parameters
- spec: FileSpec
  文件规格
- access_level: ResourceAccessLevel
  资源访问级别
Returns Promise<BackendResult<string>>
文件ID
- Defined in connector.ts:2648

createSnapshot

createSnapshot(
    guestID: string,
    label: string,
    description?: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
创建快照
Parameters
- guestID: string
  云主机ID
- label: string
  标签
- Optionaldescription: string
  快照描述
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
创建结果
- Defined in connector.ts:3413

deleteComputePool

deleteComputePool(poolID: string): Promise<BackendResult<void>>
删除计算资源池
Parameters
- poolID: string
  资源池ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2084

deleteDiskFile

deleteDiskFile(fileID: string): Promise<BackendResult<void>>
删除磁盘文件
Parameters
- fileID: string
  文件ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2802

deleteGuest

deleteGuest(
guestID: string,
timeoutSeconds?: number,
): Promise<BackendResult<void>>
删除云主机
Parameters
- guestID: string
  云主机ID
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:952

deleteISOFile

deleteISOFile(fileID: string): Promise<BackendResult<void>>
删除ISO文件
Parameters
- fileID: string
  文件ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2678

deleteSnapshot

deleteSnapshot(
    guestID: string,
    snapshotID: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
删除快照
Parameters
- guestID: string
  云主机ID
- snapshotID: string
  快照ID
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:3524

deleteVolume

deleteVolume(
    guestID: string,
    tag: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
删除卷
Parameters
- guestID: string
  云主机ID
- tag: string
  卷标签
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:1214

disableNode

disableNode(nodeID: string): Promise<BackendResult<void>>
禁用节点
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:1999

ejectMedia

ejectMedia(
guestID: string,
timeoutSeconds?: number,
): Promise<BackendResult<void>>
弹出介质
Parameters
- guestID: string
  云主机ID
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:3008

enableNode

enableNode(nodeID: string): Promise<BackendResult<void>>
启用节点
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:1986

executeTask

executeTask(
    cmd: ControlCommandRequest,
    timeoutSeconds?: number,
    intervalSeconds?: number,
): Promise<BackendResult<TaskData>>
执行任务，发送控制命令，等待任务完成
Parameters
- cmd: ControlCommandRequest
  控制命令请求
- timeoutSeconds: number = 300
  超时时间（秒），默认5分钟
- intervalSeconds: number = 1
  检查间隔（秒），默认1秒
Returns Promise<BackendResult<TaskData>>
任务数据
- Defined in connector.ts:687

fetchAllSSHKeys

fetchAllSSHKeys(): Promise<BackendResult<SSHKeyView[]>>
获取所有SSH密钥

Returns Promise<BackendResult<SSHKeyView[]>>
SSH密钥列表
- Defined in connector.ts:5389

fetchAllSystems

fetchAllSystems(): Promise<BackendResult<GuestSystemView[]>>
获取所有系统模板

Returns Promise<BackendResult<GuestSystemView[]>>
系统列表
- Defined in connector.ts:5430

generateUserToken

generateUserToken(
    user: string,
    description?: string,
    expireInMonths?: number,
): Promise<BackendResult<string>>
生成用户令牌
Parameters
- user: string
  用户标识
- Optionaldescription: string
  描述
- OptionalexpireInMonths: number
  过期时间（月）
Returns Promise<BackendResult<string>>
用户令牌
- Defined in connector.ts:816

getActivatedLicense

getActivatedLicense(): Promise<BackendResult<License>>
获取已激活的许可证

Returns Promise<BackendResult<License>>
许可证信息
- Defined in connector.ts:4204

getAddressPool

getAddressPool(poolID: string): Promise<BackendResult<AddressPool>>
获取地址池详情
Parameters
- poolID: string
  地址池ID
Returns Promise<BackendResult<AddressPool>>
地址池详情

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2463

getComputePool

getComputePool(poolID: string): Promise<BackendResult<ComputePoolStatus>>
获取计算资源池详情
Parameters
- poolID: string
  资源池ID
Returns Promise<BackendResult<ComputePoolStatus>>
计算资源池状态
- Defined in connector.ts:2032

getConfig

getConfig(nodeID: string): Promise<BackendResult<NodeConfigStatus>>
获取节点配置
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<NodeConfigStatus>>
节点配置状态
- Defined in connector.ts:4093

getDiskFile

getDiskFile(fileID: string): Promise<BackendResult<FileStatus>>
获取磁盘文件详情
Parameters
- fileID: string
  文件ID
Returns Promise<BackendResult<FileStatus>>
文件状态
- Defined in connector.ts:2839

getDiskFileURL

getDiskFileURL(fileID: string): string
获取磁盘文件URL
Parameters
- fileID: string
  文件ID
Returns string
文件URL
- Defined in connector.ts:2903

getGroupRoles

getGroupRoles(group: string): Promise<BackendResult<UserRole[]>>
获取用户组角色
Parameters
- group: string
  用户组
Returns Promise<BackendResult<UserRole[]>>
用户角色列表
- Defined in connector.ts:4798

getGuest

getGuest(guestID: string): Promise<BackendResult<GuestView>>
获取云主机详情
Parameters
- guestID: string
  云主机ID
Returns Promise<BackendResult<GuestView>>
云主机详情
- Defined in connector.ts:976

getISOFile

getISOFile(fileID: string): Promise<BackendResult<FileStatus>>
获取ISO文件详情
Parameters
- fileID: string
  文件ID
Returns Promise<BackendResult<FileStatus>>
文件状态
- Defined in connector.ts:2715

getISOFileURL

getISOFileURL(fileID: string): string
获取ISO文件URL
Parameters
- fileID: string
  文件ID
Returns string
文件URL
- Defined in connector.ts:2894

getLicense

getLicense(licenseID: string): Promise<BackendResult<License>>
获取许可证
Parameters
- licenseID: string
  许可证ID
Returns Promise<BackendResult<License>>
许可证信息
- Defined in connector.ts:4268

getMonitorRules

getMonitorRules(): Promise<BackendResult<ResourceMonitorConfig>>
获取监控规则

Returns Promise<BackendResult<ResourceMonitorConfig>>
资源监控配置
- Defined in connector.ts:4343

getNode

getNode(nodeID: string): Promise<BackendResult<ClusterNodeData>>
获取节点详情
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<ClusterNodeData>>
节点数据
- Defined in connector.ts:1964

getResourcePermissions

getResourcePermissions(
type: ResourceType,
id: string,
): Promise<BackendResult<ResourcePermissions>>
获取资源权限
Parameters
- type: ResourceType
  资源类型
- id: string
  资源ID
Returns Promise<BackendResult<ResourcePermissions>>
资源权限结果
- Defined in connector.ts:5279

getSnapshot

getSnapshot(
guestID: string,
snapshotID: string,
): Promise<BackendResult<SnapshotRecord>>
获取快照
Parameters
- guestID: string
  云主机ID
- snapshotID: string
  快照ID
Returns Promise<BackendResult<SnapshotRecord>>
快照记录
- Defined in connector.ts:3354

getStoragePool

getStoragePool(poolID: string): Promise<BackendResult<StoragePool>>
获取存储池详情
Parameters
- poolID: string
  存储池ID
Returns Promise<BackendResult<StoragePool>>
存储池详情
- Defined in connector.ts:2172

getSystem

getSystem(systemID: string): Promise<BackendResult<GuestSystemView>>
获取系统模板
Parameters
- systemID: string
  系统ID
Returns Promise<BackendResult<GuestSystemView>>
系统模板视图
- Defined in connector.ts:3754

getSystemStatus

getSystemStatus(): Promise<BackendResult<SystemStatus>>
获取系统状态

Returns Promise<BackendResult<SystemStatus>>
系统状态
- Defined in connector.ts:773

getTask

getTask(taskID: string): Promise<BackendResult<TaskData>>
获取任务详情
Parameters
- taskID: string
  任务ID
Returns Promise<BackendResult<TaskData>>
任务数据
- Defined in connector.ts:709

hasRole

hasRole(role: UserRole): boolean
检查用户是否具有指定角色
Parameters
- role: UserRole
  角色
Returns boolean
是否具有角色
- Defined in connector.ts:250

initializeSystem

initializeSystem(user: string, password: string): Promise<BackendResult<void>>
初始化系统
Parameters
- user: string
  用户标识
- password: string
  密码
Returns Promise<BackendResult<void>>
初始化结果
- Defined in connector.ts:796

insertMedia

insertMedia(
    guestID: string,
    mediaId: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
插入介质
Parameters
- guestID: string
  云主机ID
- mediaId: string
  光盘ISO文件ID
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2964

invalidateAccess

invalidateAccess(token: string): Promise<BackendResult<void>>
使访问权限失效
Parameters
- token: string
  令牌
Returns Promise<BackendResult<void>>
使访问权限失效结果
- Defined in connector.ts:5123

isFeatureEnabled

isFeatureEnabled(feature: LicenseFeature): Promise<boolean>
检查指定功能是否已启用
Parameters
- feature: LicenseFeature
  要检查的功能
Returns Promise<boolean>
功能是否已启用
- Defined in connector.ts:5373

loadTokens

loadTokens(tokens: AllocatedTokens): BackendResult
直接加载令牌，初始化校验状态
Parameters
- tokens: AllocatedTokens
  令牌
Returns BackendResult
加载结果
- Defined in connector.ts:411

logoutDevice

logoutDevice(): Promise<BackendResult<void>>
注销设备

Returns Promise<BackendResult<void>>
注销结果
- Defined in connector.ts:5470

markAllWarningsAsRead

markAllWarningsAsRead(): Promise<BackendResult<void>>
标记所有警告为已读

Returns Promise<BackendResult<void>>
标记结果
- Defined in connector.ts:4026

markAllWarningsAsUnread

markAllWarningsAsUnread(): Promise<BackendResult<void>>
标记所有警告为未读

Returns Promise<BackendResult<void>>
标记结果
- Defined in connector.ts:4037

markWarningsAsRead

markWarningsAsRead(idList: string[]): Promise<BackendResult<void>>
标记警告为已读
Parameters
- idList: string[]
  警告ID列表
Returns Promise<BackendResult<void>>
标记结果
- Defined in connector.ts:4012

modifyAddressPool

modifyAddressPool(
    id: string,
    mode: InterfaceMode,
    description?: string,
): Promise<BackendResult<void>>
修改地址池
Parameters
- id: string
  地址池ID
- mode: InterfaceMode
  接口模式
- Optionaldescription: string
  描述
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2515

modifyAutoStart

modifyAutoStart(
    guestID: string,
    enable: boolean,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改自动启动
Parameters
- guestID: string
  云主机ID
- enable: boolean
  是否启用自动启动
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:1558

modifyComputePool

modifyComputePool(config: ComputePoolConfig): Promise<BackendResult<void>>
修改计算资源池
Parameters
- config: ComputePoolConfig
  计算资源池配置
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2069

modifyConfig

modifyConfig(nodeID: string, config: NodeConfig): Promise<BackendResult<void>>
修改节点配置
Parameters
- nodeID: string
  节点ID
- config: NodeConfig
  节点配置
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:4074

modifyDiskFile

modifyDiskFile(fileID: string, spec: FileSpec): Promise<BackendResult<void>>
修改磁盘文件
Parameters
- fileID: string
  文件ID
- spec: FileSpec
  文件规格
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2816

modifyExternalInterfaceMAC

modifyExternalInterfaceMAC(
    guestID: string,
    device: string,
    macAddress: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改外部接口MAC地址
Parameters
- guestID: string
  云主机ID
- device: string
  目标设备(当前MAC)
- macAddress: string
  MAC地址
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:4671

modifyGroupRoles

modifyGroupRoles(group: string, roles: UserRole[]): Promise<BackendResult<void>>
修改用户组角色
Parameters
- group: string
  用户组
- roles: UserRole[]
  角色列表
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:4779

modifyGuestCPU

modifyGuestCPU(
    guestID: string,
    cores: number,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改云主机CPU
Parameters
- guestID: string
  云主机ID
- cores: number
  CPU核心数
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:1274

modifyGuestHostname

modifyGuestHostname(
    guestID: string,
    hostname: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改云主机主机名
Parameters
- guestID: string
  云主机ID
- hostname: string
  主机名
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:1433

modifyGuestMemory

modifyGuestMemory(
    guestID: string,
    memoryMB: number,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改云主机内存
Parameters
- guestID: string
  云主机ID
- memoryMB: number
  内存大小(MB)
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:1373

modifyImportSource

modifyImportSource(
    id: string,
    url: string,
    token: string,
    secret: string,
): Promise<BackendResult<void>>
修改导入源
Parameters
- id: string
  导入源ID
- url: string
  导入源URL
- token: string
  认证token
- secret: string
  认证secret
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:4479

modifyInternalInterfaceMAC

modifyInternalInterfaceMAC(
    guestID: string,
    device: string,
    macAddress: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改内部接口MAC地址
Parameters
- guestID: string
  云主机ID
- device: string
  目标设备(当前MAC)
- macAddress: string
  MAC地址
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:4732

modifyISOFile

modifyISOFile(fileID: string, spec: FileSpec): Promise<BackendResult<void>>
修改ISO文件
Parameters
- fileID: string
  文件ID
- spec: FileSpec
  文件规格
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2692

modifyPassword

modifyPassword(
    guestID: string,
    user: string,
    password: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改密码
Parameters
- guestID: string
  云主机ID
- user: string
  用户名
- password: string
  新密码
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:1497

modifyRemoteContainer

modifyRemoteContainer(
    poolID: string,
    index: number,
    container: VolumeContainer,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
修改远程容器
Parameters
- poolID: string
  存储池ID
- index: number
  容器索引
- container: VolumeContainer
  容器配置
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2348

modifyRemoteStorageStrategy

modifyRemoteStorageStrategy(
poolID: string,
strategy: VolumeContainerStrategy,
): Promise<BackendResult<void>>
修改远程存储策略
Parameters
- poolID: string
  存储池ID
- strategy: VolumeContainerStrategy
  存储策略
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2223

modifyResourceContainer

modifyResourceContainer(
    nodeID: string,
    poolID: string,
    index: number,
    container: VolumeContainer,
): Promise<BackendResult<void>>
修改节点本地存储池容器
Parameters
- nodeID: string
  节点ID
- poolID: string
  池ID
- index: number
  容器索引
- container: VolumeContainer
  容器配置
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:3257

modifyResourceStorageStrategy

modifyResourceStorageStrategy(
    nodeID: string,
    poolID: string,
    strategy: VolumeContainerStrategy,
): Promise<BackendResult<void>>
修改节点本地存储池策略
Parameters
- nodeID: string
  节点ID
- poolID: string
  池ID
- strategy: VolumeContainerStrategy
  存储策略
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:3210

modifySystem

modifySystem(
    systemID: string,
    label: string,
    spec: GuestSystemSpec,
): Promise<BackendResult<void>>
修改系统模板
Parameters
- systemID: string
  系统ID
- label: string
  标签
- spec: GuestSystemSpec
  系统规格
Returns Promise<BackendResult<void>>
修改结果
- Defined in connector.ts:3803

openMonitorChannel

openMonitorChannel(guestID: string): Promise<BackendResult<MonitorResponse>>
打开监控通道
Parameters
- guestID: string
  云主机ID
Returns Promise<BackendResult<MonitorResponse>>
监控响应，用于打开监控通道
- Defined in connector.ts:2912

queryAccesses

queryAccesses(
    user: string,
    offset: number,
    limit: number,
): Promise<BackendResult<PaginationResult<UserAccessRecord>>>
查询访问记录
Parameters
- user: string
  用户名
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<UserAccessRecord>>>
访问记录分页结果
- Defined in connector.ts:5140

queryAddressPools

queryAddressPools(
offset: number,
limit: number,
): Promise<BackendResult<PaginationResult<AddressPoolRecord>>>
查询地址池列表
Parameters
- offset: number
  起始位置
- limit: number
  限制数量
Returns Promise<BackendResult<PaginationResult<AddressPoolRecord>>>
地址池列表

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2427

queryClusterStatus

queryClusterStatus(): Promise<BackendResult<ClusterStatus>>
查询集群状态

Returns Promise<BackendResult<ClusterStatus>>
集群状态
- Defined in connector.ts:4307

queryClusterUsage

queryClusterUsage(): Promise<BackendResult<ClusterResourceSnapshot>>
查询集群资源用量

Returns Promise<BackendResult<ClusterResourceSnapshot>>
集群资源快照
- Defined in connector.ts:3690

queryComputeNodes

queryComputeNodes(poolID: string): Promise<BackendResult<ClusterNodeData[]>>
查询资源池内计算节点
Parameters
- poolID: string
  计算资源池ID
Returns Promise<BackendResult<ClusterNodeData[]>>
集群节点数据列表
- Defined in connector.ts:3609

queryComputePools

queryComputePools(): Promise<BackendResult<ComputePoolStatus[]>>
查询计算资源池

Returns Promise<BackendResult<ComputePoolStatus[]>>
计算资源池状态列表
- Defined in connector.ts:2011

queryDevices

queryDevices(
offset: number,
limit: number,
): Promise<BackendResult<PaginationResult<UserAccessRecord>>>
查询当前用户已登录设备列表
Parameters
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<UserAccessRecord>>>
设备列表
- Defined in connector.ts:5490

queryDiskFiles

queryDiskFiles(
    offset: number,
    limit: number,
    onlySelf?: boolean,
): Promise<BackendResult<PaginationResult<FileView>>>
查询磁盘文件列表
Parameters
- offset: number
  起始位置
- limit: number
  限制数量
- onlySelf: boolean = false
  是否只查询当前用户的磁盘文件
Returns Promise<BackendResult<PaginationResult<FileView>>>
磁盘文件列表
- Defined in connector.ts:2861

queryGroupMembers

queryGroupMembers(
    group: string,
    offset: number,
    limit: number,
): Promise<BackendResult<PaginationResult<string>>>
查询用户组成员
Parameters
- group: string
  用户组
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<string>>>
用户组成员分页结果
- Defined in connector.ts:4826

queryGroups

queryGroups(
offset: number,
limit: number,
): Promise<BackendResult<PaginationResult<UserGroupRecord>>>
查询用户组
Parameters
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<UserGroupRecord>>>
用户组分页结果
- Defined in connector.ts:4890

queryGuests

queryGuests(
    start: number,
    limit: number,
    filter?: GuestFilter,
): Promise<BackendResult<PaginationResult<GuestView>>>
查询云主机
Parameters
- start: number
  起始位置
- limit: number
  限制数量
- Optionalfilter: GuestFilter
  过滤条件
Returns Promise<BackendResult<PaginationResult<GuestView>>>
云主机列表
- Defined in connector.ts:1301

queryImportSources

queryImportSources(
start: number,
limit: number,
): Promise<BackendResult<PaginationResult<ImportSource>>>
查询导入源
Parameters
- start: number
  起始索引
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<ImportSource>>>
导入源分页结果
- Defined in connector.ts:4518

queryImportTargets

queryImportTargets(sourceID: string): Promise<BackendResult<ImportTarget[]>>
查询导入目标
Parameters
- sourceID: string
  导入源ID
Returns Promise<BackendResult<ImportTarget[]>>
导入目标列表
- Defined in connector.ts:4549

queryISOFiles

queryISOFiles(
    offset: number,
    limit: number,
    onlySelf?: boolean,
): Promise<BackendResult<PaginationResult<FileView>>>
查询ISO文件列表
Parameters
- offset: number
  起始位置
- limit: number
  限制数量
- onlySelf: boolean = false
  是否只查询当前用户的ISO文件
Returns Promise<BackendResult<PaginationResult<FileView>>>
ISO文件列表
- Defined in connector.ts:2737

queryLicenses

queryLicenses(): Promise<BackendResult<LicenseRecord[]>>
查询所有许可证

Returns Promise<BackendResult<LicenseRecord[]>>
许可证记录列表
- Defined in connector.ts:4289

queryLogs

queryLogs(
    date: string,
    offset?: number,
    limit?: number,
): Promise<BackendResult<PaginationResult<ConsoleEvent>>>
查询日志
Parameters
- date: string
  日期,"yyyy-MM-dd"
- Optionaloffset: number
  偏移量
- Optionallimit: number
  每页日志行数
Returns Promise<BackendResult<PaginationResult<ConsoleEvent>>>
日志分页结果
- Defined in connector.ts:3852

queryNetworkGraph

queryNetworkGraph(): Promise<BackendResult<NetworkGraphNode[]>>
查询网络拓扑图

Returns Promise<BackendResult<NetworkGraphNode[]>>
网络拓扑节点列表
- Defined in connector.ts:4325

queryNodes

queryNodes(): Promise<BackendResult<ClusterNodeData[]>>
查询节点列表

Returns Promise<BackendResult<ClusterNodeData[]>>
节点数据列表
- Defined in connector.ts:1945

queryNodesUsage

queryNodesUsage(
targets: string[],
): Promise<BackendResult<NodeResourceSnapshot[]>>
查询节点使用情况
Parameters
- targets: string[]
  目标节点id列表
Returns Promise<BackendResult<NodeResourceSnapshot[]>>
节点资源快照列表
- Defined in connector.ts:3633

queryPoolsUsage

queryPoolsUsage(
targets: string[],
): Promise<BackendResult<PoolResourceSnapshot[]>>
查询计算资源池资源用量
Parameters
- targets: string[]
  目标池id列表
Returns Promise<BackendResult<PoolResourceSnapshot[]>>
池资源快照列表
- Defined in connector.ts:3662

queryResourcePools

queryResourcePools(nodeID: string): Promise<BackendResult<DataStore[]>>
查询节点本地存储池列表
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<DataStore[]>>
节点存储池列表
- Defined in connector.ts:3184

queryResourceStatistic

queryResourceStatistic(
guest: string,
range: StatisticRange,
): Promise<BackendResult<ResourceStatisticUnit[]>>
查询云主机资源统计信息
Parameters
- guest: string
  云主机ID
- range: StatisticRange
  统计范围
Returns Promise<BackendResult<ResourceStatisticUnit[]>>
资源统计单元列表
- Defined in connector.ts:3578

queryResourceUsages

queryResourceUsages(
targets: string[],
): Promise<BackendResult<GuestResourceUsageData[]>>
查询云主机资源使用情况
Parameters
- targets: string[]
  目标云主机id列表
Returns Promise<BackendResult<GuestResourceUsageData[]>>
资源使用数据列表
- Defined in connector.ts:3548

querySnapshots

querySnapshots(guestID: string): Promise<BackendResult<SnapshotTreeNode[]>>
查询快照
Parameters
- guestID: string
  云主机ID
Returns Promise<BackendResult<SnapshotTreeNode[]>>
快照树节点列表
- Defined in connector.ts:3329

querySSHKeys

querySSHKeys(
    offset: number,
    pageSize: number,
    onlySelf?: boolean,
): Promise<BackendResult<PaginationResult<SSHKeyView>>>
查询SSH密钥
Parameters
- offset: number
  偏移量
- pageSize: number
  每页最大记录数
- onlySelf: boolean = false
  是否只查询当前用户的密钥
Returns Promise<BackendResult<PaginationResult<SSHKeyView>>>
SSH密钥视图列表
- Defined in connector.ts:4172

queryStoragePools

queryStoragePools(): Promise<BackendResult<StoragePoolListRecord[]>>
查询存储池列表

Returns Promise<BackendResult<StoragePoolListRecord[]>>
存储池列表
- Defined in connector.ts:2151

querySystems

querySystems(
    offset: number,
    pageSize: number,
    onlySelf?: boolean,
): Promise<BackendResult<PaginationResult<GuestSystemView>>>
查询系统模板
Parameters
- offset: number
  起始位置
- pageSize: number
  每页记录数量
- onlySelf: boolean = false
  是否只查询当前用户的系统模板
Returns Promise<BackendResult<PaginationResult<GuestSystemView>>>
系统模板视图列表
- Defined in connector.ts:3721

queryTasks

queryTasks(
offset: number,
pageSize: number,
): Promise<BackendResult<PaginationResult<TaskData>>>
查询任务
Parameters
- offset: number
  偏移量
- pageSize: number
  每页大小
Returns Promise<BackendResult<PaginationResult<TaskData>>>
包含任务分页结果的结果
- Defined in connector.ts:1885

queryUserRoles

queryUserRoles(): Promise<BackendResult<UserRole[]>>
查询用户角色

Returns Promise<BackendResult<UserRole[]>>
用户角色列表
- Defined in connector.ts:4757

queryUsers

queryUsers(
offset: number,
limit: number,
): Promise<BackendResult<PaginationResult<UserCredentialRecord>>>
查询用户
Parameters
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<UserCredentialRecord>>>
用户分页结果
- Defined in connector.ts:4960

queryUserTokens

queryUserTokens(
    user: string,
    offset: number,
    limit: number,
): Promise<BackendResult<PaginationResult<UserToken>>>
查询用户令牌
Parameters
- user: string
  用户名
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<UserToken>>>
用户令牌分页结果
- Defined in connector.ts:5013

queryWarnings

queryWarnings(
    level?: ConsoleEventLevel,
    unread_only?: boolean,
    offset?: number,
    limit?: number,
): Promise<BackendResult<WarningRecordSet>>
查询警告
Parameters
- Optionallevel: ConsoleEventLevel
  警告级别
- Optionalunread_only: boolean
  是否只查询未读
- Optionaloffset: number
  偏移量
- Optionallimit: number
  每页警告数量
Returns Promise<BackendResult<WarningRecordSet>>
警告记录集
- Defined in connector.ts:3888

queryWhiteList

queryWhiteList(
offset: number,
limit: number,
): Promise<BackendResult<PaginationResult<string>>>
查询白名单
Parameters
- offset: number
  偏移量
- limit: number
  每页数量
Returns Promise<BackendResult<PaginationResult<string>>>
白名单分页结果
- Defined in connector.ts:5224

release

release(): void
释放资源

Returns void
- Defined in connector.ts:186

removeAddressPool

removeAddressPool(poolID: string): Promise<BackendResult<void>>
删除地址池
Parameters
- poolID: string
  地址池ID
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2537

removeComputeNode

removeComputeNode(poolID: string, nodeID: string): Promise<BackendResult<void>>
从资源池移除计算节点
Parameters
- poolID: string
  资源池ID
- nodeID: string
  节点ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2115

removeExternalAddressRange

removeExternalAddressRange(
    poolID: string,
    beginAddress: string,
    endAddress: string,
): Promise<BackendResult<void>>
删除外部地址范围
Parameters
- poolID: string
  地址池ID
- beginAddress: string
  起始地址
- endAddress: string
  结束地址
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2601

removeExternalInterface

removeExternalInterface(
    guestID: string,
    macAddress: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
移除外部接口
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
移除结果
- Defined in connector.ts:1678

removeGroup

removeGroup(group: string): Promise<BackendResult<void>>
删除用户组
Parameters
- group: string
  用户组
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:4874

removeImportSource

removeImportSource(id: string): Promise<BackendResult<void>>
删除导入源
Parameters
- id: string
  导入源ID
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:4502

removeInternalAddressRange

removeInternalAddressRange(
    poolID: string,
    beginAddress: string,
    endAddress: string,
): Promise<BackendResult<void>>
删除内部地址范围
Parameters
- poolID: string
  地址池ID
- beginAddress: string
  起始地址
- endAddress: string
  结束地址
Returns Promise<BackendResult<void>>
操作结果

Deprecated
地址池相关接口全部会重新设计
- Defined in connector.ts:2625

removeInternalInterface

removeInternalInterface(
    guestID: string,
    macAddress: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
移除内部接口
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
移除结果
- Defined in connector.ts:1801

removeLicense

removeLicense(licenseID: string): Promise<BackendResult<void>>
删除许可证
Parameters
- licenseID: string
  许可证ID
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:4253

removeNode

removeNode(nodeID: string): Promise<BackendResult<void>>
移除节点
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:1933

removeRemoteContainer

removeRemoteContainer(
    poolID: string,
    index: number,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
删除远程容器
Parameters
- poolID: string
  存储池ID
- index: number
  容器索引
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2403

removeResourceContainer

removeResourceContainer(
    nodeID: string,
    poolID: string,
    index: number,
): Promise<BackendResult<void>>
删除节点本地存储池容器
Parameters
- nodeID: string
  节点ID
- poolID: string
  池ID
- index: number
  容器索引
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:3282

removeSSHKey

removeSSHKey(id: string): Promise<BackendResult<void>>
删除SSH密钥
Parameters
- id: string
  密钥ID
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:4155

removeStoragePool

removeStoragePool(poolID: string): Promise<BackendResult<void>>
删除存储池
Parameters
- poolID: string
  存储池ID
Returns Promise<BackendResult<void>>
操作结果
- Defined in connector.ts:2209

removeSystem

removeSystem(systemID: string): Promise<BackendResult<void>>
删除系统模板
Parameters
- systemID: string
  系统ID
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:3824

removeUser

removeUser(userId: string): Promise<BackendResult<void>>
删除用户
Parameters
- userId: string
  用户ID
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:4944

removeWarnings

removeWarnings(idList: string[]): Promise<BackendResult<void>>
删除警告
Parameters
- idList: string[]
  警告ID列表
Returns Promise<BackendResult<void>>
删除结果
- Defined in connector.ts:3986

removeWhiteList

removeWhiteList(index: number): Promise<BackendResult<void>>
移除白名单
Parameters
- index: number
  白名单索引
Returns Promise<BackendResult<void>>
移除结果
- Defined in connector.ts:5188

resetMonitor

resetMonitor(
guestID: string,
timeoutSeconds?: number,
): Promise<BackendResult<void>>
重置监控
Parameters
- guestID: string
  云主机ID
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
重置结果
- Defined in connector.ts:1860

resetMonitorRules

resetMonitorRules(): Promise<BackendResult<void>>
重置监控规则

Returns Promise<BackendResult<void>>
重置结果
- Defined in connector.ts:4427

resetSystems

resetSystems(): Promise<BackendResult<void>>
重置系统模板

Returns Promise<BackendResult<void>>
重置结果
- Defined in connector.ts:3838

resetUserSecret

resetUserSecret(user: string): Promise<BackendResult<string>>
重置用户密码
Parameters
- user: string
  用户名
Returns Promise<BackendResult<string>>
新密码
- Defined in connector.ts:5086

restartService

restartService(nodeID: string): Promise<BackendResult<void>>
重启服务
Parameters
- nodeID: string
  节点ID
Returns Promise<BackendResult<void>>
重启结果
- Defined in connector.ts:4117

restoreSnapshot

restoreSnapshot(
    guestID: string,
    snapshotID: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
恢复快照
Parameters
- guestID: string
  云主机ID
- snapshotID: string
  快照ID
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
恢复结果
- Defined in connector.ts:3471

revokeAccess

revokeAccess(token: string): Promise<BackendResult<void>>
撤销访问权限
Parameters
- token: string
  令牌
Returns Promise<BackendResult<void>>
撤销结果
- Defined in connector.ts:5108

revokeUserToken

revokeUserToken(user: string, serial: string): Promise<BackendResult<void>>
撤销用户令牌
Parameters
- user: string
  用户名
- serial: string
  序列号
Returns Promise<BackendResult<void>>
撤销结果
- Defined in connector.ts:5047

setMonitorRules

setMonitorRules(rules: ResourceMonitorConfig): Promise<BackendResult<void>>
设置监控规则
Parameters
- rules: ResourceMonitorConfig
  资源监控配置
Returns Promise<BackendResult<void>>
设置结果
- Defined in connector.ts:4364

setResourcePermissions

setResourcePermissions(
    type: ResourceType,
    id: string,
    permissions: ResourcePermissions,
): Promise<BackendResult<void>>
设置资源权限
Parameters
- type: ResourceType
  资源类型
- id: string
  资源ID
- permissions: ResourcePermissions
  资源权限
Returns Promise<BackendResult<void>>
设置结果
- Defined in connector.ts:5309

setSystemResource

setSystemResource(
    type: ResourceType,
    id: string,
    value: boolean,
): Promise<BackendResult<void>>
设置系统资源
Parameters
- type: ResourceType
  资源类型
- id: string
  资源ID
- value: boolean
  资源值
Returns Promise<BackendResult<void>>
设置结果
- Defined in connector.ts:5257

startGuest

startGuest(
    guestID: string,
    media?: string,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
启动云主机
Parameters
- guestID: string
  云主机ID
- Optionalmedia: string
  ISO镜像ID（可选）
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
启动结果
- Defined in connector.ts:1029

startHeartBeat

startHeartBeat(): void
计划刷新令牌,访问令牌过期时间提前90秒，自动触发刷新令牌

Returns void
- Defined in connector.ts:429

startTask

startTask(cmd: ControlCommandRequest): Promise<BackendResult<string>>
启动任务，发送控制命令，返回任务ID
Parameters
- cmd: ControlCommandRequest
  控制命令请求
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:662

stopGuest

stopGuest(
    guestID: string,
    reboot: boolean,
    force: boolean,
    timeoutSeconds?: number,
): Promise<BackendResult<void>>
停止云主机
Parameters
- guestID: string
  云主机ID
- reboot: boolean
  是否重启云主机
- force: boolean
  是否强制执行
- timeoutSeconds: number = 300
  超时时间（秒），默认300秒
Returns Promise<BackendResult<void>>
停止结果
- Defined in connector.ts:1093

sumWarnings

sumWarnings(nodeList: string[]): Promise<BackendResult<WarningStatistic>>
统计多个节点警告总数
Parameters
- nodeList: string[]
  节点列表
Returns Promise<BackendResult<WarningStatistic>>
警告统计信息
- Defined in connector.ts:3956

tryAddExternalInterface

tryAddExternalInterface(
guestID: string,
macAddress: string,
): Promise<BackendResult<string>>
尝试添加外部接口，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1584

tryAddInternalInterface

tryAddInternalInterface(
guestID: string,
macAddress: string,
): Promise<BackendResult<string>>
尝试添加内部接口，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1707

tryAddRemoteContainer

tryAddRemoteContainer(
poolID: string,
container: VolumeContainer,
): Promise<BackendResult<string>>
尝试添加远程容器，成功返回任务ID
Parameters
- poolID: string
  存储池ID
- container: VolumeContainer
  容器配置
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:2266

tryAddVolume

tryAddVolume(
guestID: string,
volume: VolumeSpec,
): Promise<BackendResult<string>>
尝试添加卷，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- volume: VolumeSpec
  磁盘卷配置
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:1120

tryCreateDiskImage

tryCreateDiskImage(
    guestID: string,
    volumeTag: string,
    spec: FileSpec,
    access_level: ResourceAccessLevel,
): Promise<BackendResult<string>>
尝试创建磁盘镜像，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- volumeTag: string
  卷标签
- spec: FileSpec
  文件规格
- access_level: ResourceAccessLevel
  资源访问级别
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3118

tryCreateGuest

tryCreateGuest(
    poolID: string,
    system: string,
    config: GuestConfig,
): Promise<BackendResult<string>>
尝试创建云主机，成功返回任务ID
Parameters
- poolID: string
  计算资源池
- system: string
  目标系统
- config: GuestConfig
  云主机配置
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:856

tryCreateSnapshot

tryCreateSnapshot(
    guestID: string,
    label: string,
    description?: string,
): Promise<BackendResult<string>>
尝试创建快照，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- label: string
  标签
- Optionaldescription: string
  快照描述
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3382

tryDeleteGuest

tryDeleteGuest(guestID: string): Promise<BackendResult<string>>
尝试删除云主机，成功返回任务ID
Parameters
- guestID: string
  云主机ID
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:923

tryDeleteSnapshot

tryDeleteSnapshot(
guestID: string,
snapshotID: string,
): Promise<BackendResult<string>>
尝试删除快照，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- snapshotID: string
  快照ID
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3496

tryDeleteVolume

tryDeleteVolume(guestID: string, tag: string): Promise<BackendResult<string>>
尝试删除卷，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- tag: string
  卷标签
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:1180

tryEjectMedia

tryEjectMedia(guestID: string): Promise<BackendResult<string>>
尝试弹出介质，成功返回任务ID
Parameters
- guestID: string
  云主机ID
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:2985

tryImportGuestsToNode

tryImportGuestsToNode(
    sourceID: string,
    targetIDs: string[],
    targetNode: string,
): Promise<BackendResult<string>>
尝试导入云主机到节点
Parameters
- sourceID: string
  导入源ID
- targetIDs: string[]
  目标云主机ID列表
- targetNode: string
  目标节点ID
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:4577

tryInsertMedia

tryInsertMedia(guestID: string, mediaId: string): Promise<BackendResult<string>>
尝试插入介质，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- mediaId: string
  光盘ISO文件ID
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:2936

tryInstallDiskImage

tryInstallDiskImage(
    guestID: string,
    volumeTag: string,
    fileID: string,
): Promise<BackendResult<string>>
尝试安装磁盘镜像，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- volumeTag: string
  卷标签
- fileID: string
  文件ID
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3087

tryMigrateToNode

tryMigrateToNode(
targetNode: string,
guests: string[],
): Promise<BackendResult<string>>
尝试迁移云主机到节点
Parameters
- targetNode: string
  目标节点ID
- guests: string[]
  云主机ID列表
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:4608

tryModifyAutoStart

tryModifyAutoStart(
guestID: string,
enable: boolean,
): Promise<BackendResult<string>>
尝试修改自动启动，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- enable: boolean
  是否启用自动启动
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1524

tryModifyExternalInterfaceMAC

tryModifyExternalInterfaceMAC(
    guestID: string,
    device: string,
    macAddress: string,
): Promise<BackendResult<string>>
尝试修改外部接口MAC地址
Parameters
- guestID: string
  云主机ID
- device: string
  目标设备(当前MAC)
- macAddress: string
  MAC地址
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:4638

tryModifyGuestCPU

tryModifyGuestCPU(
guestID: string,
cores: number,
): Promise<BackendResult<string>>
尝试修改云主机CPU，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- cores: number
  CPU核心数
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:1240

tryModifyGuestHostname

tryModifyGuestHostname(
guestID: string,
hostname: string,
): Promise<BackendResult<string>>
尝试修改云主机主机名，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- hostname: string
  主机名
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1399

tryModifyGuestMemory

tryModifyGuestMemory(
guestID: string,
memoryMB: number,
): Promise<BackendResult<string>>
尝试修改云主机内存，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- memoryMB: number
  内存大小(MB)
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:1339

tryModifyInternalInterfaceMAC

tryModifyInternalInterfaceMAC(
    guestID: string,
    device: string,
    macAddress: string,
): Promise<BackendResult<string>>
尝试修改内部接口MAC地址
Parameters
- guestID: string
  云主机ID
- device: string
  目标设备(当前MAC)
- macAddress: string
  MAC地址
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:4699

tryModifyPassword

tryModifyPassword(
    guestID: string,
    user: string,
    password: string,
): Promise<BackendResult<string>>
尝试修改密码，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- user: string
  用户名
- password: string
  新密码
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1460

tryModifyRemoteContainer

tryModifyRemoteContainer(
    poolID: string,
    index: number,
    container: VolumeContainer,
): Promise<BackendResult<string>>
尝试修改远程容器，成功返回任务ID
Parameters
- poolID: string
  存储池ID
- index: number
  容器索引
- container: VolumeContainer
  容器配置
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:2317

tryReloadResourceStorage

tryReloadResourceStorage(
nodeID: string,
poolID: string,
): Promise<BackendResult<string>>
尝试重新加载资源节点存储
Parameters
- nodeID: string
  节点ID
- poolID: string
  节点存储标识
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:4382

tryRemoveExternalInterface

tryRemoveExternalInterface(
guestID: string,
macAddress: string,
): Promise<BackendResult<string>>
尝试移除外部接口，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1644

tryRemoveInternalInterface

tryRemoveInternalInterface(
guestID: string,
macAddress: string,
): Promise<BackendResult<string>>
尝试移除内部接口，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- macAddress: string
  MAC地址
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1767

tryRemoveRemoteContainer

tryRemoveRemoteContainer(
poolID: string,
index: number,
): Promise<BackendResult<string>>
尝试删除远程容器，成功返回任务ID
Parameters
- poolID: string
  存储池ID
- index: number
  容器索引
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:2375

tryResetMonitor

tryResetMonitor(guestID: string): Promise<BackendResult<string>>
尝试重置监控，成功返回任务ID
Parameters
- guestID: string
  云主机ID
Returns Promise<BackendResult<string>>
包含任务id的结果
- Defined in connector.ts:1829

tryResizeDisk

tryResizeDisk(
    guestID: string,
    volumeTag: string,
    sizeInMB: number,
): Promise<BackendResult<string>>
尝试调整磁盘大小，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- volumeTag: string
  卷标签
- sizeInMB: number
  大小（MB）
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3030

tryRestoreSnapshot

tryRestoreSnapshot(
guestID: string,
snapshotID: string,
): Promise<BackendResult<string>>
尝试恢复快照，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- snapshotID: string
  快照ID
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3443

tryShrinkDisk

tryShrinkDisk(
guestID: string,
volumeTag: string,
): Promise<BackendResult<string>>
尝试收缩磁盘，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- volumeTag: string
  卷标签
Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3059

tryStartGuest

tryStartGuest(guestID: string, media?: string): Promise<BackendResult<string>>
尝试启动云主机，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- Optionalmedia: string
  ISO镜像ID（可选）
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:1000

tryStopGuest

tryStopGuest(
    guestID: string,
    reboot: boolean,
    force: boolean,
): Promise<BackendResult<string>>
尝试停止云主机，成功返回任务ID
Parameters
- guestID: string
  云主机ID
- reboot: boolean
  是否重启云主机
- force: boolean
  是否强制执行
Returns Promise<BackendResult<string>>
任务id
- Defined in connector.ts:1056

trySyncDiskFiles

trySyncDiskFiles(): Promise<BackendResult<string>>
尝试同步磁盘文件，成功返回任务ID

Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3165

trySyncISOFiles

trySyncISOFiles(): Promise<BackendResult<string>>
尝试同步ISO文件，成功返回任务ID

Returns Promise<BackendResult<string>>
任务ID
- Defined in connector.ts:3147

updateDiskVolumeSize

updateDiskVolumeSize(
fileID: string,
sizeInMB: number,
): Promise<BackendResult<void>>
更新磁盘卷大小
Parameters
- fileID: string
  文件ID
- sizeInMB: number
  大小（MB）
Returns Promise<BackendResult<void>>
更新结果
- Defined in connector.ts:4409

updateWhiteList

updateWhiteList(index: number, address: string): Promise<BackendResult<void>>
更新白名单
Parameters
- index: number
  白名单索引
- address: string
  新的白名单地址
Returns Promise<BackendResult<void>>
更新结果
- Defined in connector.ts:5204

waitTask

waitTask(
    taskID: string,
    timeoutSeconds?: number,
    intervalSeconds?: number,
): Promise<BackendResult<TaskData>>
等待任务完成
Parameters
- taskID: string
  任务ID
- timeoutSeconds: number = 300
  超时时间（秒）
- intervalSeconds: number = 1
  检查间隔（秒）
Returns Promise<BackendResult<TaskData>>
任务数据
- Defined in connector.ts:738

Class TaiyiConnector

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TaiyiConnector

Accessors

authenticated

Returns boolean

id

Returns string

roles

Returns UserRole[]

user

Returns string

Methods

activateLicense

Parameters

Returns Promise<BackendResult<void>>

addAddressPool

Parameters

Returns Promise<BackendResult<void>>

Deprecated

addComputeNode

Parameters

Returns Promise<BackendResult<void>>

addComputePool

Parameters

Returns Promise<BackendResult<void>>

addExternalAddressRange

Parameters

Returns Promise<BackendResult<void>>

Deprecated

addExternalInterface

Parameters

Returns Promise<BackendResult<void>>

addGroup

Parameters

Returns Promise<BackendResult<void>>

addImportSource

Parameters

Returns Promise<BackendResult<void>>

addInternalAddressRange

Parameters

Returns Promise<BackendResult<void>>

Deprecated

addInternalInterface

Parameters

Returns Promise<BackendResult<void>>

addLicense

Parameters

Returns Promise<BackendResult<void>>

addNode

Parameters

Returns Promise<BackendResult<void>>

addRemoteContainer

Parameters

Returns Promise<BackendResult<void>>

addResourceContainer

Parameters

Returns Promise<BackendResult<void>>

addSSHKey

Parameters

Returns Promise<BackendResult<void>>

addStoragePool

Parameters

Returns Promise<BackendResult<void>>

addSystem

Parameters

Returns Promise<BackendResult<void>>

addUser

Parameters

Returns Promise<BackendResult<void>>

addVolume

Parameters

Returns Promise<BackendResult<void>>