获取云桌面实例详情
接口描述
本接口用于获取桌面实例详情。
请求结构
GET /v1/bvd/desktops/{desktopId}
Host: bec.baidubce.com
Authorization: authorization string
请求参数
| 参数名称 |
参数说明 |
请求类型 |
是否必须 |
数据类型 |
| desktopId |
桌面ID |
path |
true |
string |
响应状态
| 状态码 |
说明 |
schema |
| 200 |
OK |
DesktopModelVo |
| 401 |
Unauthorized |
|
| 403 |
Forbidden |
|
| 404 |
Not Found |
|
响应参数
| 参数名称 |
参数说明 |
类型 |
schema |
| desktopId |
桌面ID |
string |
|
| name |
桌面名称 |
string |
|
| spec |
规格族 |
string |
|
| specName |
规格名称 |
string |
|
| status |
桌面状态: idle 空闲, inuse 使用中, offline 离线, processing 进行中, error 异常 |
string |
|
| cpuCount |
CPU数 |
integer(int32) |
integer(int32) |
| cpuModel |
CPU类型 |
string |
|
| memorySizeInGB |
内存GB |
integer(int32) |
integer(int32) |
| gpuCount |
GPU卡数 |
integer(int32) |
integer(int32) |
| gpuModel |
GPU、vGPU卡型号 |
string |
|
| billing |
订单、计费相关参数 |
Billing |
Billing |
| paymentTiming |
付费方式 |
string |
|
| rootDisk |
系统盘 |
DiskModel |
DiskModel |
| id |
云磁盘ID |
string |
|
| name |
云磁盘名称 |
string |
|
| sizeInGB |
磁盘容量 |
integer(int32) |
|
| storageType |
磁盘类型 |
string |
|
| dataDiskList |
数据盘 |
array |
DiskModel |
| id |
云磁盘ID |
string |
|
| name |
云磁盘名称 |
string |
|
| sizeInGB |
磁盘容量 |
integer(int32) |
|
| storageType |
磁盘类型 |
string |
|
| imageId |
镜像Id |
string |
|
| image |
镜像详情 |
ImageVo |
ImageVo |
| gpuMode |
无，vgpu：虚拟GPU， pt：直通 |
string |
|
| imageId |
镜像ID |
string |
|
| imageType |
镜像类型: system公共镜像, custom自定义镜像 |
string |
|
| name |
镜像名称 |
string |
|
| osName |
操作系统名称 |
string |
|
| osType |
操作系统类型 |
string |
|
| size |
镜像占用磁盘大小，单位GB |
integer(int32) |
|
| internalIp |
内网IP地址 |
string |
|
| macAddress |
MAC地址 |
string |
|
| networkCapacityInMbps |
带宽 |
integer(int32) |
integer(int32) |
| networkType |
公网类型, NAT或PUBLIC_IP |
string |
|
| publicIp |
公网IP地址 |
string |
|
| regionId |
所在节点ID |
string |
|
| securityGroupId |
安全组Id |
string |
|
| securityGroupName |
安全组Name |
string |
|
| serverStatus |
服务器状态: CREATING，RUNNING，STOPPING，STOPPED，DELETING RESTARTING，REINSTALLING，STARTING，IMAGING，SNAPSHOTING, ROLLBACKING, FAILED，NOTEXIST |
string |
|
| subnetCidr |
子网CIDR |
string |
|
| subnetId |
子网ID |
string |
|
| subnetName |
子网名称 |
string |
|
| vpcCidr |
VPC网段 |
string |
|
| vpcId |
VPC ID |
string |
|
| vpcName |
VPC名称 |
string |
|
| createTime |
创建时间 |
string |
|
| endUserCount |
已分配用户数量 |
integer(int32) |
integer(int32) |
| endUsers |
已分配的用户 |
array |
EndUserVo |
| endUserId |
终端用户ID |
string |
|
| name |
终端用户登录名 |
string |
|
错误码
请参照错误返回章节的内容。
请求示例
GET /v1/bvd/desktops/vd-hqmf4tzi-cn-baoding-ix-us6lv?maxKeys=10&marker= HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
响应示例
{
"desktopId": "vd-hqmf4tzi-cn-baoding-ix-us6lv",
"name": "sample",
"macAddress": "fa:16:xx:xx:xx:xx",
"internalIp": "172.19.176.191",
"status": "idle",
"serverStatus": "RUNNING",
"spec": "bvd.vgn4.c4m8.t4-4Q",
"specName": "云桌面vGPU-T4型",
"cpuCount": 4,
"cpuModel": "Intel Xeon Gold 6271C",
"memorySizeInGB": 8,
"gpuCount": 1,
"gpuModel": "NVIDIA GRID T4-4Q(4GB)",
"imageId": "m-xxxxx",
"image": {
"imageId": "m-o3up8rjn",
"name": "windows_10_21h2_vgpu_universal",
"imageType": "system",
"size": 50,
"osName": "Windows 10",
"gpuMode": "vgpu"
},
"regionId": "cn-baoding-ix",
"rootDisk": {
"storageType": "CDS_SSD",
"sizeInGB": 100,
"id": "cds-vd-xxxx-rootfs"
},
"dataDiskList": [],
"billing": {
"paymentTiming": "Postpaid"
},
"vpcId": "vpc-2ojwafbg",
"vpcName": "default",
"vpcCidr": "172.19.176.0/20",
"subnetId": "sbn-ujqxxxx",
"subnetName": "default",
"subnetCidr": "172.19.176.0/24",
"securityGroupId": "sg-xxxxx",
"securityGroupName": "virtual-desktop-sg",
"createTime": "2023-12-29T06:55:57Z",
"endUserCount": 2,
"endUsers": [
{
"endUserId": "xxxxxx",
"name": "user1"
},
{
"endUserId": "xxxxxx",
"name": "user2"
}
]
}
