DescribeDesktopTypes - 查询云电脑规格详细信息

更新时间:
复制为 MD 格式

查询云电脑规格的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeDesktopTypes

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

BusinessChannel

string

RegionId

string

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou

DesktopTypeId

string

规格 ID。

说明

InstanceTypeFamilyDesktopTypeId参数的取值均为空时,将查询云电脑所有规格的信息。

枚举值:

  • eds.enterprise_office.4c8g :

    eds.enterprise_office.4c8g

  • eds.hf.4c8g :

    eds.hf.4c8g

  • ecd.basic.large :

    ecd.basic.large

  • ecd.advanced.large :

    ecd.advanced.large

  • eds.enterprise_office.8c16g :

    eds.enterprise_office.8c16g

  • ecd.basic.small :

    ecd.basic.small

  • ecd.graphics.2xlarge :

    ecd.graphics.2xlarge

  • eds.hf.8c16g :

    eds.hf.8c16g

  • eds.hf.12c24g :

    eds.hf.12c24g

  • eds.general.8c16g :

    eds.general.8c16g

  • eds.general.16c32g :

    eds.general.16c32g

  • ecd.advanced.xlarge :

    ecd.advanced.xlarge

  • eds.graphics.16c1t4 :

    eds.graphics.16c1t4

  • ecd.graphics.xlarge :

    ecd.graphics.xlarge

  • ecd.performance.2xlarge :

    ecd.performance.2xlarge

  • eds.general.8c32g :

    eds.general.8c32g

  • eds.general.2c2g :

    eds.general.2c2g

  • eds.general.2c4g :

    eds.general.2c4g

  • eds.graphics.24c1t4 :

    eds.graphics.24c1t4

  • eds.general.4c8g :

    eds.general.4c8g

  • eds.enterprise_office.2c4g :

    eds.enterprise_office.2c4g

  • eds.general.4c16g :

    eds.general.4c16g

  • eds.general.2c8g :

    eds.general.2c8g

ecd.graphics.xlarge

InstanceTypeFamily

string

规格族名称。

说明

InstanceTypeFamilyDesktopTypeId参数的取值均为空时,将查询云电脑所有规格的信息。

枚举值:

  • ecd.advanced :

    ecd.advanced

  • eds.graphics :

    eds.graphics

  • ecd.basic :

    ecd.basic

  • eds.enterprise_office :

    eds.enterprise_office

  • eds.hf :

    eds.hf

  • ecd.graphics :

    ecd.graphics

  • eds.general :

    eds.general

  • ecd.performance :

    ecd.performance

ecd.graphics

CpuCount

integer

vCPU 数量。

2

MemorySize

integer

内存大小。单位为 MiB。

4096

GpuCount

number

GPU 核数。

1

DesktopIdForModify

string

变配时传入需要变配的云电脑 ID,返回值会增加规格与云电脑之间是否兼容的信息。

ecd-gx2x1dhsmucyy****

OrderType

string

订单类型。

枚举值:

  • DOWNGRADE :

    降级配置

  • UPGRADE :

    升级配置

DOWNGRADE

AppliedScope

string

规格适用范围。默认值:Public

枚举值:

  • Public :

    Public

  • SavingPlan :

    SavingPlan

Public

DesktopGroupIdForModify

string

变配时传入需要变配的共享型云电脑 ID,返回值会增加规格与共享型云电脑之间是否兼容的信息。

dg-abcdefg****

GpuDriverType

string

GPU 驱动类型。

枚举值:

  • T4 :

    T4

  • A10 :

    A10

  • G28 :

    G28

  • G39 :

    G39

A10

OrderBy

string

排序字段,若不指定则按照创建时间倒序排列。

枚举值:

  • Memory :

    按照内存大小排序

  • Cpu :

    按照 CPU 核数排序

Memory

SortType

string

排序方式。

枚举值:

  • ASC :

    升序 [默认值]

  • DESC :

    降序

ASC

Scope

string

规格的售卖方式。

枚举值:

  • MonthPackage :

    按月包购买

  • FastBuy :

    快速购买

FastBuy

DesktopTypeIdList

array

规格 ID 列表。

string

规格 ID。

eds.enterprise.4c8g

SupportMinSessionCount

integer

查询规则支持的多会话数量。

2

ZoneId

string

说明

该参数未对外开放使用。

GpuMemory

integer

ScopeSet

array

string

OfficeSiteId

string

返回参数

名称

类型

描述

示例值

object

返回信息集合。

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

DesktopTypes

array<object>

规格的详细信息。

object

规格的详细信息。

SystemDiskSize

string

系统盘大小。单位:GiB。

150

DesktopTypeId

string

规格 ID。

ecd.graphics.xlarge

DataDiskSize

string

数据盘大小。单位:GiB。

150

CpuCount

string

vCPU 数量。

2

GpuCount

number

GPU 核数。

1

GpuSpec

string

GPU 显存。

16 GiB

InstanceTypeFamily

string

规格族。

ecd.graphics

MemorySize

string

内存大小。单位:MiB。

23552

DesktopTypeStatus

string

规格状态。返回SUFFICIENT时表示该规格资源充足。

SUFFICIENT

Scopes

array

规格售卖方式列表。

string

规格的售卖方式。

枚举值:

  • MonthPackage :

    按月包购买

  • FastBuy :

    快速购买

FastBuy

StockState

string

库存状态。

枚举值:

  • Insufficient :

    无库存

  • Sufficient :

    库存充足

Sufficient

GpuMemory

integer

显存大小。对于 GPU 型云电脑,该返回值有实际意义。单位:MB。

2048

MaxSessionCount

integer

当前规格支持的多会话数量。

4

Description

string

EnvType

string

EnvId

string

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DesktopTypes": [
    {
      "SystemDiskSize": "150",
      "DesktopTypeId": "ecd.graphics.xlarge",
      "DataDiskSize": "150",
      "CpuCount": "2",
      "GpuCount": 1,
      "GpuSpec": "16 GiB",
      "InstanceTypeFamily": "ecd.graphics",
      "MemorySize": "23552",
      "DesktopTypeStatus": "SUFFICIENT",
      "Scopes": [
        "FastBuy"
      ],
      "StockState": "Sufficient",
      "GpuMemory": 2048,
      "MaxSessionCount": 4,
      "Description": "",
      "EnvType": "",
      "EnvId": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情