接口功能介绍

计算增强型云电脑功能请联系客户经理开通。

接口约束

无

URI

GET /v3/ecs/describe

路径参数
无

Query参数

参数	是否必填	参数类型	说明	示例
regionId	是	String	资源池ID。	xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
desktopOid	否	String	云电脑ID
desktopNickName	否	String	云电脑别名
vpcOid	否	String	vpcId
subnetOidList	否	String	VPC子网ID。取值由VPC子网ID组成一个JSON数组，最多支持20个ID，ID之间用半角逗号（,）隔开。
status	否	String	运行状态（Creating-创建中;Stopped-已关机;Starting-启动中;Running-运行中;Rebooting-重启中;Rebuilding-重装中;Stopping-关闭中;Deleting-删除中;Unhealthy-异常;RollingBack-回滚中;Resizing-变更中;Evacuating-迁移中;Rescuing-救援中;BackingUp-备份中;DeletingBackup-删除备份中;Regaining-恢复中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-唤醒中）
pageNum	否	Integer	页码，至少1，默认1
pageSize	否	Integer	每页数量，最大100，默认10

请求参数

请求头header参数
无

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	状态码。可能值： - 800：请求成功。 - 900：请求失败。	800
error	String	错误码。	ECPC_1000
message	String	提示信息。	OK.
returnObj	Object	返回数据对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
total	Long	总记录数
list	Array of Objects	数据列表		list

表 list

参数	参数类型	说明	示例	下级对象
desktopOid	String	云电脑ID	XXXXXXXXXXXXX6925
desktopName	String	云电脑名称
nickname	String	云电脑别名
osType	String	操作系统类型（Windows;Linux）
status	String	运行状态（Creating-创建中;Stopped-已关机;Starting-启动中;Running-运行中;Rebooting-重启中;Rebuilding-重装中;Stopping-关闭中;Deleting-删除中;Deleted-已删除;Unhealthy-异常;RollingBack-回滚中;Resizing-变更中;Evacuating-迁移中;Rescuing-救援中;BackingUp-备份中;DeletingBackup-删除备份中;Regaining-恢复中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-唤醒中）
flavorType	String	规格类型。可能值：[Common-通用型, Gpu-GPU型, Hpn-高性能网络型, Kp-鲲鹏, Hg-海光]。
cpuArch	String	CPU架构。仅对XC型规格有意义。可能值：[arm, x86]。
processorType	String	处理器类型。仅对XC型规格有意义。可能值： - kp：鲲鹏。 - hg：海光。	kp
cpu	Integer	CPU个数
memory	Integer	内存大小（单位：GB）
gpuMemory	Integer	显存大小（单位：GB）。仅对GPU规格云电脑有意义。
sysDisk	Object	系统盘		sysDisk
dataDisks	Array of Objects	数据盘		dataDisks
imageOid	String	镜像ID
templateOid	String	规格模板ID
osName	String	操作系统名称
org	Object	归属部门		org
vpcOid	String	VPC ID
vpcName	String	VPC名称
subnets	Array of Objects	所在子网集合		subnets
eipAddresses	Array of Objects	弹性ip列表		eipAddresses
pubUserOid	String	分配用户ID（当且仅当用户与云电脑绑定成功时返回）
userName	String	分配用户名称（当且仅当用户与云电脑绑定成功时返回）
chargeType	String	计费方式。枚举值范围：[PrePaid-包年包月, ResourcePack-资源包]
createTime	String	创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
expireTime	String	到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

表 sysDisk

参数	参数类型	说明	示例
diskOid	String	磁盘ID
diskType	String	磁盘类型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO）
diskSize	Integer	磁盘大小。单位：GB
availableBytes	String	磁盘剩余可用字节数。单位：B。注意：上报情况存在延迟，可能为空。	66666666666
diskUuid	String	磁盘UUID

表 dataDisks

参数	参数类型	说明	示例
diskOid	String	磁盘ID
diskType	String	磁盘类型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO）
diskSize	Integer	磁盘大小。单位：GB
availableBytes	String	磁盘剩余可用字节数。单位：B。注意：上报情况存在延迟，可能为空。	66666666666
diskUuid	String	磁盘UUID

表 org

参数	参数类型	说明	示例	下级对象
orgOid	String	部门ID
completeOrgName	String	完整部门名称。由从根部门到当前部门的名称，以半角斜线号（/）为分隔符拼接而成。

表 subnets

参数	参数类型	说明	示例	下级对象
subnetOid	String	子网ID
privateIpAddresses	Array of Objects	私有IP地址集合		privateIpAddresses

表 privateIpAddresses

参数	参数类型	说明
address	String	IP地址
portOid	String	网卡ID
isDefault	Boolean	是否为默认网卡，true表示是，false表示否

表 eipAddresses

参数	参数类型	说明
eipOid	String	弹性IP ID
ipAddress	String	IP地址
privateIpAddress	String	私有IP地址

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

无

响应示例

{
  "statusCode":800,
  "message":"OK.",
  "returnObj":{
    "total":1,
    "list":[{
      "desktopOid":"XXXXXXXXXXXXX6925",
      "desktopName":"desktopName",
      "nickname":"nickname",
      "osType":"Windows",
      "status":"Running",
      "flavorType":"Common",
      "cpu":1,
      "memory":2,
      "gpuMemory":2,
      "org":{
        "orgOid":"fooId",
        "completeOrgName":"fooRootName/fooName"
      },
      "vpcOid":"vpc-xxx",
      "vpcName":"fooName",
      "subnets":[{
        "subnetOid":"sn-xxx",
        "privateIpAddresses":[{
          "address":"192.168.1.99",
          "portOid":"port-xxx",
          "isDefault":true
        }]
      }],
      "eipAddresses":[{
        "eipOid":"XXX",
        "ipAddress":"X.X.X.X",
        "privateIpAddress":"X.X.X.X"
      }],
      "sysDisk":{
        "diskOid":"vol-xxx",
        "diskType":"hio",
        "diskSize":80,
        "availableBytes":"66666666666"
      },
      "dataDisks":[{
        "diskOid":"vol-yyy",
        "diskType":"hio",
        "diskSize":10,
        "availableBytes":"6666666666"
      }],
      "imageOid":"mi-xxx",
      "templateOid":"xxx",
      "osName":"Windows 2016 Standard 64位 中文版",
      "pubUserOid":"upg-xxx",
      "userName":"fooName",
      "chargeType":"ResourcePack",
      "createTime":"2099-09-09T00:00:00Z",
      "expireTime":"2099-09-09T00:00:00Z"
    }]
  }
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

天翼云电脑（政企版）

天翼云电脑（政企版）

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

天翼云电脑（政企版）

天翼云电脑（政企版）

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码