帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-10-27 17:22:14
我的收藏

AttributeInfo

实例属性key--value结构

被如下接口引用:ModifyImageAttrs, ModifyInstanceBasicAttribute。

名称 类型 必选 描述
Name String 是

实例属性名


示例值:attr-name
Value String 是

实例属性值


示例值:attr-value

BindInfo

绑定关系

被如下接口引用:UnbindInstances。

名称 类型 必选 描述
UserId String 是

实例绑定的用户ID


示例值:"user-rfc"
InstanceId String 是

实例ID


示例值:"cdi-deffg2342sdfg"

BindStatusInfo

桌面实例绑定状态详情

被如下接口引用:BindInstances, DescribeInstancesBindStatus。

名称 类型 描述
InstanceId String

桌面实例id


示例值:"cdi-a"
BindStatus String

实例的绑定状态。取值:
UNBOUND - 未绑定
BINDING - 绑定中
BOUND - 绑定
UNBINDING-解绑中


示例值:"BINDING"
UserId String

绑定的用户id【BOUND状态不允许为空】


注意:此字段可能返回 null,表示取不到有效值。
示例值:"user-1"
UserName String

绑定用户名称【BOUND状态不允许为空】


注意:此字段可能返回 null,表示取不到有效值。
示例值:"username-1"
DisplayName String

绑定用户显示名称【BOUND状态不允许为空】


注意:此字段可能返回 null,表示取不到有效值。
示例值:"displayname-1"

ChargePrepaid

预付费模式,即包年包月相关参数。包括购买时长和自动续费逻辑等。

被如下接口引用:CreateInstances, RenewInstances。

名称 类型 必选 描述
Period Integer 是 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12。
示例值:5
RenewFlag String 否 自动续费标识。取值范围:
NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
示例值:NOTIFY_AND_AUTO_RENEW

CommandDetail

任务详情

被如下接口引用:DescribeCommandTasks。

名称 类型 描述
Uin String 租户 Uin
示例值:100000077643
AppId Integer 租户 APPID
示例值:13846212
Type String 任务类型,取值有:
PowerShellScript
Bat
示例值:任务类型
Status String RUNNING - 执行中;FINISHED - 执行完成
示例值:任务状态
Command String 任务脚本,Base64 编码
示例值:aXBjb25maWc=
CommandId String 任务唯一 ID
示例值:ac5b1e88-9862-423e-9595-10f2998096b5
CreateTime String 任务完成时间
示例值:2025-04-22 14:01:23
FinishTime String 任务完成时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-04-22 14:01:23
Invocations Array of InvocationDetail 各实例运行结果集
RunAsBoundUser Boolean 是否以绑定用户运行任务,默认 false:system 用户执行
示例值:false
RunForeground Boolean 是否前台运行任务,默认 false:后台运行任务
示例值:false

DataPoint

监控数据

被如下接口引用:DescribeInstanceMonitorData。

名称 类型 描述
Dimensions Array of Dimension

实例对象维度组合

Timestamps Array of Float

时间戳数组


示例值:[1535079000, 1535079300]
Values Array of Float

监控值数组,与Timestamps一一对应


示例值:[2.566,2.283]
MaxValues Array of Float

MaxValues 最大值数组,与Timestamps一一对应


示例值:[5.0]
MinValues Array of Float

MinValues 最小值数组,与Timestamps一一对应


示例值:[1.0]
AvgValues Array of Float

AvgValues 平均值数组,与Timestamps一一对应


示例值:[3.0]

Dimension

实例对象的维度组合

被如下接口引用:DescribeInstanceMonitorData。

名称 类型 必选 描述
Name String 否 实例维度名称
示例值:InstanceId
Value String 否 实例维度值
示例值:cdi-zvxnv9y9s31dd4h

Disk

桌面实例挂载磁盘信息

被如下接口引用:CreateInstances, DescribeInstances, ModifyDiskConfiguration。

名称 类型 必选 描述
DiskType String 是

磁盘类型:
CLOUD_SSD:SSD云硬盘
CLOUD_PREMIUM:高性能云硬盘


示例值:CLOUD_PREMIUM
DiskSize Integer 是

磁盘大小(单位G)
系统盘最小值50,最大值500
数据盘最小值10,最大值32000。最小调整步长为10G


示例值:50
DiskId String 否

磁盘id


注意:此字段可能返回 null,表示取不到有效值。
示例值:disk-de925des1

DistributionInfo

各地域实例个数信息

被如下接口引用:DescribeInstanceRegionDistribution。

名称 类型 描述
Region String

地域描述


示例值:ap-singapore
Count Integer

实例个数


示例值:1

DomainControlDetail

域名控制策略详情

被如下接口引用:CreateDomainControlPolicy。

名称 类型 必选 描述
Domain String 是 配置域名
示例值:*.testcvd.com
Address String 是 此参数必填,新版本无异议,请求包和回包强制填写空字符串,做校验
示例值:11.10.0.11,11.10.0.12
Description String 否 规则描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试域名

Filter

查询因子

被如下接口引用:DeleteCommandTasks, DescribeCommandTasks, DescribeImages, DescribeInstances, DescribePolicyDetail, DescribeSnapshots, DescribeUsage, StopCommandTasks。

名称 类型 必选 描述
Name String 是 要匹配的参数名
示例值:"Name"
Values Array of String 是 要匹配的参数值
示例值:["A","B"]

ImageInfo

云桌面镜像信息

被如下接口引用:DescribeImages。

名称 类型 描述
ImageID String

镜像id


示例值:img-dc2467
ImageName String

镜像名称


示例值:imge test
ImageType String

镜像类型:
PUBLIC_IMAGE-公共镜像
PRIVATE_IMAGE-自定义镜像
TENCENT_OFFICE_IMAGE-腾讯办公镜像


示例值:PRIVATE_IMAGE
ImageState String

镜像状态:
CREATING-创建中
NORMAL-正常
CREATEFAILED-创建失败
USING-使用中
SYNCING-同步中
IMPORTING-导入中
IMPORTFAILED-导入失败
INVISIBLE-淘汰的镜像
DELETIING-删除中
DELETED-删除的


示例值:NORMAL
OsName String

镜像操作系统


示例值:Window Server 2019
ImageSize Integer

镜像大小(单位G)


示例值:50
Description String

镜像描述


示例值:test image
Region String

镜像所在区域


示例值:ap-shanghai
CoreType String

内核类型:
CPU
GPU
GPU_A10
GPU_RTX6000
GPU_2080Ti
GPU_3080Ti


示例值:CPU
CvmImageId String

cvm侧镜像id


注意:此字段可能返回 null,表示取不到有效值。
示例值:img-test1234
IsWhole Boolean

是否是整机镜像,整机镜像无法用于桌面重置
true:整机镜像
false: 不是整机镜像


注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DataDiskSize Integer

整机镜像中数据盘大小


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CreateTime String

镜像创建时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-10-01 12:00:00

Instance

实例维度组合数组

被如下接口引用:DescribeInstanceMonitorData。

名称 类型 必选 描述
Dimensions Array of Dimension 否 实例的维度组合

InstanceInfo

云桌面实例详细信息

被如下接口引用:DescribeInstances。

名称 类型 描述
InstanceId String

实例id


示例值:"cdi-a"
Name String

实例名称


示例值:"a"
Status String

实例状态
PENDING:表示创建中
LAUNCH_FAILED:表示创建失败
RUNNING:表示运行中
STOPPED:表示关机
STARTING:表示开机中
STOPPING:表示关机中
REBOOTING:表示重启中
SHUTDOWN:表示停止待销毁
TERMINATING:表示销毁中
DELETED:表示资源已经销毁,这个状态是业务层面的状态,cvm如果销毁了,在cvm侧资源已经不存在了
FAILED:表示资源创建失败.这个是业务层面的状态
ROLLBACKING:表示回滚中
USING:表示使用中
RESETTING:表示重置中.


示例值:"RUNNING"
UserName String

实例拥有者名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:"a"
UserId String

实例


注意:此字段可能返回 null,表示取不到有效值。
示例值:"a"
InstanceType String

实例规格
S1.LARGE8:4VCPU 2.5GHZ主频 8G内存 无显卡
S1.LARGE16:4VCPU 2.5GHZ主频 16G内存 无显卡
S2.2XLARGE16:8VCPU 3.2GHZ主频 16G内存 无显卡
G1.LARGE16:4VCPU 2.5GHZ主频 16G内存 1/4 NVIDIA T4
G1.2XLARGE32:8VCPU 2.5GHZ主频 32G内存 1/2 NVIDIA T4
G1.4XLARGE64:16VCPU 2.5GHZ主频 64G内存 1 NVIDIA T4


示例值:"S1.LARGE8"
SysDisk Disk

系统盘信息

DataDiskList Array of Disk

挂载的数据盘信息


注意:此字段可能返回 null,表示取不到有效值。
Region String

桌面实例所在的区域


示例值:"ap-shanghai"
ChargeType String

桌面计费类型


示例值:"POSTPAID_BY_HOUR"
AutoRenewFlag String

自动续费标识。取值范围:
NOTIFY_AND_MANUAL_RENEW:表示通知即将过期,但不自动续费
NOTIFY_AND_AUTO_RENEW:表示通知即将过期,而且自动续费
DISABLE_NOTIFY_AND_MANUAL_RENEW:表示不通知即将过期,也不自动续费。

注意:后付费模式本项为null


示例值:"NOTIFY_AND_MANUAL_RENEW"
CreateTime Timestamp ISO8601

桌面创建时间


示例值:2021-04-27T08:49:34Z
ExpiredTime Timestamp ISO8601

桌面过期时间


示例值:2022-04-27T08:49:34Z
Description String

桌面描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:示例数据
HostName String

桌面hostname


注意:此字段可能返回 null,表示取不到有效值。
示例值:"a"
DisplayName String

桌面拥有者显示名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:"a"
BindStatus String

桌面绑定状态。取值:
UNBOUND - 未绑定
BINDING - 绑定中
BOUND - 绑定


注意:此字段可能返回 null,表示取不到有效值。
示例值:"BOUND"
ImageId String

创建桌面的镜像id


注意:此字段可能返回 null,表示取不到有效值。
示例值:"image-a"
UserVpcId String

用户桌面vpc id


注意:此字段可能返回 null,表示取不到有效值。
示例值:"vpc-a"
UserSubnetId String

用户桌面子网 id


注意:此字段可能返回 null,表示取不到有效值。
示例值:"subnet-a"
UserPrivateIp String

用户桌面ip


注意:此字段可能返回 null,表示取不到有效值。
示例值:"x.x.x.x"
IsolatedTime String

机器回收站到期时间,只有机器状态为SHUTDOWN该值才有意义


注意:此字段可能返回 null,表示取不到有效值。
示例值:"0001-01-01T00:00:00.000Z"
LastStatusChangeReason String

最近一次状态变更原因, AUTO:被动变更,如欠费,如包月实例到期, MANUAL:主动变更,如主动退还实例,当前只有机器处于ISOLATING、SHUTDOWN、TERMINATING、DELETED该字段有意义


注意:此字段可能返回 null,表示取不到有效值。
示例值:"AUTO"
LatestOperation String

机器最近一次操作


注意:此字段可能返回 null,表示取不到有效值。
示例值:StartInstance
LatestOperationState String

机器最近一次操作状态


注意:此字段可能返回 null,表示取不到有效值。
示例值:Success
LatestOperationRequestID String

机器最近一次操作请求ReqId


注意:此字段可能返回 null,表示取不到有效值。
示例值:requestid
OsName String

机器操作系统名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:Windows
SetId String

实例逻辑set


注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-shanghai_1
AppId Integer

应用id


注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Uin String

账号id


注意:此字段可能返回 null,表示取不到有效值。
示例值:"189132"
SecurityGroups Array of String

关联的安全组ID列表


注意:此字段可能返回 null,表示取不到有效值。
示例值:["sg-sddf12s"]
DownGradeTimes Integer

预付费实例降配次数


注意:此字段可能返回 null,表示取不到有效值。
示例值:2
DomainControlPolicies Array of String

桌面绑定的域名策略ID列表,最多五个


注意:此字段可能返回 null,表示取不到有效值。
示例值:["domain-data1","domain-data2"]
WaterMarkPolicy String

桌面绑定的水印策略


注意:此字段可能返回 null,表示取不到有效值。
示例值:watermark-qyui135
ScreenRecordingPolicy String

桌面绑定的录屏策略ID


注意:此字段可能返回 null,表示取不到有效值。
示例值:srpolicy-k53h3sy9
DomainControlPolicyType String

WHITE --- 白名单策略
BLACK --- 黑名单策略


注意:此字段可能返回 null,表示取不到有效值。
示例值:WHITE
RunControlPolicy String

桌面绑定的运行管控策略


注意:此字段可能返回 null,表示取不到有效值。
示例值:appctl-run-10001
InstallControlPolicy String

桌面绑定的安装管控策略


注意:此字段可能返回 null,表示取不到有效值。
示例值:appctl-install-10001
AnonymousAccess Boolean

桌面是否绑定匿名用户


注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Tags Array of Tag

实例绑定的标签


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

InstanceStatus

实例状态

被如下接口引用:DescribeInstancesStatus。

名称 类型 描述
InstanceId String 实例id
示例值:"cvd-abc"
Status String 实例状态
PENDING:表示创建中
LAUNCH_FAILED:表示创建失败
RUNNING:表示运行中
STOPPED:表示关机
STARTING:表示开机中
STOPPING:表示关机中
REBOOTING:表示重启中
SHUTDOWN:表示停止待销毁
TERMINATING:表示销毁中
DELETED:表示资源已经销毁,这个状态是业务层面的状态,cvm如果销毁了,在cvm测资源已经不存在了
FAILED:表示资源创建失败.这个是业务层面的状态
ROLLBACKING:表示机器正在回滚中
RESETTING:表示机器正在重置中
USING:表示机器正在使用中
示例值:"RUNNING"
SessionState Integer 只有在Status为RUNNING时候,当前值才有意义
取值范围:
0:Unknown
1:Connected
2:Disconnected
3:Terminated
4:PreparingSession
5:Active
6:Reconnecting
7:NonBrokeredSession
8:Other
9:Pending
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IdleSeconds Float 此字段只有在Status为USING时,才有效。
字段意义:表示桌面当前session空闲时间(客户没有鼠标,键盘等操作),单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.00
StatusChangeTime Integer 当前状态改变的时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1600000
LatestOperation String 实例最近一次操作类型
示例值:"TerminateInstances"
LatestOperationState String 实例最近一次操作状态
示例值:"SUCCESS"

Invocation

脚本执行情况。

被如下接口引用:DescribeInvocationDetail, DescribeInvocations, RunCommand。

名称 类型 描述
InvokeId String

脚本执行ID。


示例值:96c8ae74-20af-4b89-a0bf-3506c4533756
Status String

运行状态。

  • Running:正在执行
  • Finished:已经完成
  • Failed:失败
  • Stopped:已停止

  • 示例值:Finished
    Output InvocationOutput

    任务输出。


    注意:此字段可能返回 null,表示取不到有效值。
    ErrorCode String

    任务失败时的错误码。


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:InternalError
    ErrorInfo String

    任务失败时的错误信息描述。


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Failed
    ExitCode Integer

    任务退出状态码


    示例值:0

    InvocationDetail

    实例执行脚本任务结果详情

    被如下接口引用:DescribeCommandTasks。

    名称 类型 必选 描述
    InstanceId String 否 实例 id
    示例值:cdi-fffwjoi5ichjxxxx
    InstanceName String 否 实例名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:桌面
    Region String 否 实例所在区域,目前支持的区域有:ap-beijing、ap-shanghai、ap-guangzhou、ap-shanghai-adc
    示例值:ap-shanghai
    Status String 否 脚本任务执行状态,取值有:
    Running-执行中
    Finished-完成
    Failed-失败
    Stopped-终止
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Running
    InvokeId String 否 实例上任务唯一 ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:d70252ef-9d50-4d6d-a85d-1fbe6bd52222
    Output String 否 脚本任务输出
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ok
    ExitCode Integer 否 任务退出码
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ErrorCode String 否 任务错误码
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ErrorInfo String 否 执行任务错误信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:no

    InvocationOutput

    任务执行的标准输出。

    被如下接口引用:DescribeInvocationDetail, DescribeInvocations, RunCommand。

    名称 类型 描述
    Lines Array of String

    任务的标准输出。


    示例值:["\n"]
    LinesOffset Integer

    本次返回的输出第一行对应的索引编号。


    示例值:0
    LinesNum Integer

    本次返回的输出的行数。


    示例值:100
    Encoding String

    输出的编码方式:
    <li>PlainText 未经过Base64编码。


    示例值:PlainText
    AllLinesOffset Integer

    当前有效的输出起始编号,从0开始。输出过多,会冲掉旧的输出。


    示例值:0
    AllLinesNum Integer

    当前有效的标准输出总行数。


    示例值:100

    IpControlDetail

    IP控制策略详情

    被如下接口引用:CreateDomainControlPolicy。

    名称 类型 必选 描述
    Ip String 是

    配置的IP。支持单IP和CIDR,暂不支持IP范围


    示例值:180.101.49.44
    Description String 否

    IP的描述


    示例值:baidu ip 1

    Partition

    磁盘分区数据

    被如下接口引用:DescribeInstanceGraphData。

    名称 类型 描述
    Name String 磁盘名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:c:
    Total Float 总容量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:49.97
    Usage Float 使用量,39.31%
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:39.31

    PolicyDetail

    策略详细信息

    被如下接口引用:DescribePolicyDetail。

    名称 类型 描述
    PolicyId String

    策略id


    示例值:policy-343fwf2
    PolicyName String

    策略名称


    示例值:policy
    Description String

    策略描述


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:policy
    UserIds Array of String

    策略作用用户id列表


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["tom"]
    Uin String

    策略的租户uin


    示例值:234452234
    FilePolicyId Integer

    文件重定向策略id。取值范围:
    1:读写
    2:只读
    3:禁止读写


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    ClipPolicyId Integer

    剪切板重定向策略id。取值范围:
    1:开启云桌面到客户端
    2:开启客户端到云桌面
    3:双向开启
    4:禁用


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    DrivePolicyId Integer

    外设重定向策略id。取值范围:
    1:允许usb重定向
    2:允许端口重定向
    3:允许usb和端口重定向
    4:禁用


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    WaterMarkPolicyId Integer

    水印重定向策略id。取值范围(离散值):
    4: 当前时间,居中策略
    10: 当前时间,平铺策略
    15: 云桌面ID, 居中策略
    16: 云桌面ID+当前时间, 居中策略
    17: 云桌面ID, 平铺策略
    18: 云桌面ID+当前时间, 平铺策略


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    IsDefault Boolean

    是否是默认策略


    示例值:true
    TotalUser Integer

    注意:默认策略的当前值无效


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    PolicyInfo

    创建策略详细信息

    被如下接口引用:CreatePolicy, UpdatePolicy。

    名称 类型 必选 描述
    PolicyType Integer 是 策略类型。取值:
    1:文件重定向策略
    2:剪切板重定向策略
    3:外设重定向策略
    4:水印策略
    示例值:0
    PolicyValue Integer 是 策略值。取值:
    PolicyType对应个子取值范围:
    ①:PolicyType为1-文件重定向策略
    1:读写
    2:只读
    3:禁止读写
    ②:剪切板重定向策略
    1:开启云桌面到客户端
    2:开启客户端到云桌面
    3:双向开启
    4:禁用
    ③:外设重定向策略
    1:允许usb重定向
    2:允许端口重定向
    3:允许usb和端口重定向
    4:禁用
    ④:水印策略
    4: 当前时间,居中策略
    10: 当前时间,平铺策略
    15: 云桌面ID, 居中策略
    16: 云桌面ID+当前时间, 居中策略
    17: 云桌面ID, 平铺策略
    18: 云桌面ID+当前时间, 平铺策略
    示例值:0

    SnapshotInfo

    快照信息

    被如下接口引用:DescribeSnapshots。

    名称 类型 描述
    SnapshotId String

    快照唯一ID


    示例值:snap-1mehmi29
    DiskId String

    快照对应的云硬盘ID


    示例值:disk-nyz5l4i0
    SnapshotState String

    快照状态,取值如下:
    NORMAL:正常
    CREATING:创建中
    ROLLBACKING:回滚中
    COPYING_FROM_REMOTE:跨地域复制中
    CHECKING_COPIED:复制校验中
    TORECYCLE:待回收。


    示例值:NORMAL
    DiskUsage String

    创建此快照的云硬盘类型。取值范围:
    SYSTEM_DISK:系统盘
    DATA_DISK:数据盘。


    示例值:SYSTEM_DISK
    CreateTime String

    快照创建的时间


    示例值:2026-10-21 02:14:52
    DeadlineTime String

    快照到期时间。如果快照为永久保留,此字段为空。


    示例值:2026-10-24 02:00:00
    Percent Integer

    快照创建进度百分比,快照创建成功后此字段恒为100。


    示例值:100
    IsPermanent Boolean

    是否为永久快照。取值范围:
    true:永久快照
    false:非永久快照。


    示例值:false
    CreateType String

    快照创建方式,取值:
    ManualSnapshot:手动创建
    AutoSnapshot:快照策略自动创建


    示例值:AutoSnapshot
    LastRollbackTime String

    上一次快照回滚完成时间


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2026-10-10 02:00:00
    LastRollbackState String

    上一次快照回滚状态,取值:
    成功:SUCCESS
    失败:FAILED


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SUCCESS

    Tag

    Tag

    被如下接口引用:CreateInstances, DescribeInstances。

    名称 类型 必选 描述
    TagKey String 否 标签键
    示例值:key1
    TagValue String 否 标签值
    示例值:value1

    Usage

    桌面使用时长详情

    被如下接口引用:DescribeUsage。

    名称 类型 描述
    InstanceId String 桌面实例 ID
    示例值:cdi-xdu11f8osd72cyf
    Name String 桌面名称
    示例值:test-cvd
    Status String 桌面当前状态
    示例值:RUNNING
    UserName String 桌面绑定的用户名,若未绑定,为空
    示例值:test-user
    ChargeType String 桌面计费类型
    示例值:PREPAID
    InstanceType String 桌面类型
    示例值:S1L.LARGE8
    OsName String 桌面操作系统
    示例值:Windows Server 2019
    ActiveTime String 桌面使用时长,h:m:s
    示例值:00:20:25
    IdleTime String 桌面空闲时长,h:m:s
    示例值:00:00:50
    AnonymousAccess Boolean 是否匿名访问
    示例值:false

    User

    用户信息

    被如下接口引用:DescribeUsers。

    名称 类型 描述
    Id String

    用户ID。


    示例值:us-02a7aa5b2ae94e028d2304f3ecceb614
    Name String

    名字。


    示例值:dn-user
    DisplayName String

    显示名字。


    示例值:dn-user
    Mail String

    邮箱。


    示例值:dn-user@123.com
    PhoneNum String

    手机号。


    示例值:*
    Status String

    状态。
    ACTIVE:启用
    PENDING_ACTIVATE:待激活
    PENDING_ONBOARD:待启用
    SUSPENDED:已停用
    INACTIVE:已离职
    PASSWORD_RESET:重置密码
    LOCKED_OUT:锁定


    示例值:ACTIVE
    DepartmentId String

    部门ID。


    示例值:*
    StrategyId String

    策略ID。


    示例值:*
    StrategyName String

    策略名称。


    示例值:默认策略
    BindStatus Boolean

    当前用户是否绑定桌面,true:绑定,false:未绑定任何桌面


    示例值:false

    VirtualPrivateCloud

    私有网络相关信息

    被如下接口引用:CreateInstances。

    名称 类型 必选 描述
    VpcId String 是

    私有网络ID。


    示例值:vpc-hugyy71o
    SubnetId String 是

    私有网络子网ID。


    示例值:subnet-eoak5ntj