文档

DescribePatternTypes - 根据实例属性查询实例规格

调用DescribePatternTypes接口,并可以指定交换机的ID、实例的vCPU核数、内存大小、规格族级别以及可接受的最高价格等参数,筛选出符合要求的实例规格。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:DescribePatternTypes
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

所属地域的 ID。

cn-hangzhou
VSwitchIdarray

交换机的 ID 列表。

string

交换机的 ID。

vsw-bp14zolna43z266bq****
SpotStrategystring

后付费实例的抢占策略。取值范围:

  • NoSpot:普通的按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。

默认值:NoSpot。

NoSpot
Coresinteger

实例规格的 vCPU 内核数目。

2
Memoryfloat

实例规格的内存大小,单位为 GiB。

4
MaxPricefloat

按量付费实例或者抢占式实例可接受的每小时最高价格。

2
InstanceFamilyLevelstring

实例规格族级别。取值范围:

  • EntryLevel:入门级。
  • EnterpriseLevel:企业级。
  • CreditEntryLevel:积分入门级。详情请参见突发性能实例
EnterpriseLevel
ExcludedInstanceTypearray

需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:

  • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
  • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
说明 如果需要排除多个实例规格,请使用分隔符(/)隔开单个实例规格。例如ecs.n1.small/ecs.n1.*/*7*
string

需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:

  • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
  • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
说明 如果需要排除多个实例规格,请使用分隔符(/)隔开单个实例规格。例如ecs.n1.small/ecs.n1.*/*7*
ecs.c6.xlarge
Architecturearray

实例规格所属的架构类型。取值范围:

  • X86:X86 计算。
  • Heterogeneous:异构计算,例如 GPU 或 FPGA 等。
  • BareMental:弹性裸金属服务器。
  • Arm:Arm 计算。
  • SuperComputeCluster:超级计算集群。

默认值:包含所有架构类型。

string

实例规格所属的架构类型。取值范围:

  • X86:X86 计算。
  • Heterogeneous:异构计算,例如 GPU 或 FPGA 等。
  • BareMetal:弹性裸金属服务器。
  • Arm:Arm 计算。
  • SuperComputeCluster:超级计算集群。

默认值:包含所有架构类型。

X86
BurstablePerformancestring

是否为性能突发实例规格。取值范围:

  • Exclude:不包含性能突发实例规格。
  • Include:包含性能突发实例规格。
  • Required:只包含性能突发实例规格。

默认值:Include。

Include
CoresListarray

实例规格的 vCPU 内核数目,可以指定多个。

integer

实例规格的 vCPU 内核数目,可以指定多个。

2
MemoryListarray

实例规格的内存大小,单位为 GiB,可以指定多个。

float

实例规格的内存大小,单位为 GiB,可以指定多个。

4
ChannelIdlong

渠道 ID,内部保留参数。

79425074
InstanceTypeFamiliesarray

指定查询的实例规格族。N 表示可以设置多个实例规格族,N 的取值范围:1~10。

string

指定查询的实例规格族。N 表示可以设置多个实例规格族,N 的取值范围:1~10。

["ecs.g6", "ecs.c6", … "ecs.r6"]
MinimumCpuCoreCountinteger

实例规格的最小 vCPU 内核数目。

2
MaximumCpuCoreCountinteger

实例规格的最大 vCPU 内核数目。

4
GpuSpecsarray

GPU 类型。

string

GPU 类型。

["NVIDIA V100"]
InstanceCategoriesarray

实例规格分类。取值范围:

  • General-purpose: 通用型。
  • Compute-optimized:计算型。
  • Memory-optimized:内存型。
  • Big data:大数据型。
  • Local SSDs :本地 SSD 型。
  • High Clock Speed :高主频型。
  • Enhanced :增强型。
  • Shared:共享型。
  • Compute-optimized with GPU :GPU 计算型。
  • Visual Compute-optimized :视觉计算型。
  • Heterogeneous Service :异构服务型。
  • Compute-optimized with FPGA :FPGA 计算型。
  • Compute-optimized with NPU :NPU 计算型。
  • ECS Bare Metal :弹性裸金属服务器。
  • Super Computing Cluster:超级计算集群。
  • High Performance Compute:高性能计算型。
string

实例规格分类。取值范围:

  • General-purpose: 通用型。
  • Compute-optimized:计算型。
  • Memory-optimized:内存型。
  • Big data:大数据型。
  • Local SSDs :本地 SSD 型。
  • High Clock Speed :高主频型。
  • Enhanced :增强型。
  • Shared:共享型。
  • Compute-optimized with GPU :GPU 计算型。
  • Visual Compute-optimized :视觉计算型。
  • Heterogeneous Service :异构服务型。
  • Compute-optimized with FPGA :FPGA 计算型。
  • Compute-optimized with NPU :NPU 计算型。
  • ECS Bare Metal :弹性裸金属服务器。
  • Super Computing Cluster:超级计算集群。
  • High Performance Compute:高性能计算型。
["Compute-optimized with GPU"]
CpuArchitecturesarray

实例规格的 CPU 架构。取值范围:

说明 N 表示可以设置多个 CPU 架构,N 的取值范围:1~2。
  • X86。
  • ARM。
string

实例规格的 CPU 架构。取值范围:

说明 N 表示可以设置多个 CPU 架构,N 的取值范围:1~2。
  • X86。
  • ARM。
["X86", "ARM"]
PhysicalProcessorModelsarray

实例的处理器型号。N 表示可以设置多个处理器型号,N 的取值范围:1~10。

string

实例的处理器型号。N 表示可以设置多个处理器型号,N 的取值范围:1~10。

["Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY"]
MinimumEniQuantityinteger

实例最小支持挂载的弹性网卡上限。

2
MinimumEniPrivateIpAddressQuantityinteger

实例最小单块弹性网卡的 IPv4 地址上限。

2
MinimumEniIpv6AddressQuantityinteger

实例最小单块弹性网卡的 IPv6 地址上限。

1
MinimumInitialCreditinteger

实例最小突发性能实例 t5、t6 的初始 vCPU 积分值。

12
MinimumBaselineCreditinteger

实例最小突发性能实例 t5、t6 的基准 vCPU 计算性能(所有 vCPU 之和)。

12
MinimumMemorySizefloat

实例最小内存。单位:GiB。

4
MaximumMemorySizefloat

实例最大内存。单位:GiB。

4
MinimumGpuAmountinteger

实例最小 GPU 数目。取值范围:正整数。

2
MaximumGpuAmountinteger

实例最大 GPU 数目。取值范围:正整数。

2

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PatternTypesarray<object>

符合条件的实例规格。

object
InstanceTypestring

实例规格名称。

ecs.c7.xlarge
InstanceFamilyLevelstring

实例规格族级别。

  • EntryLevel:入门级,即共享型实例规格。成本更低,但是无法保证实例计算性能的稳定。适用于平时 CPU 使用率低的业务场景。更多信息,请参见共享型
  • EnterpriseLevel:企业级。性能稳定,资源独享,适用于对稳定性要求高的业务场景。更多信息,请参见实例规格族
  • CreditEntryLevel:积分入门级,即突发性能实例。通过 CPU 积分来保证计算性能,适用于平时 CPU 使用率低、偶有突发 CPU 使用率的情况。更多信息,请参见突发性能实例
EnterpriseLevel
InstanceTypeFamilystring

实例规格族。

ecs.c7
Coresinteger

实例规格的 vCPU 核数。

4
Memoryfloat

实例规格的内存大小,单位为 GiB。

8

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PatternTypes": [
    {
      "InstanceType": "ecs.c7.xlarge",
      "InstanceFamilyLevel": "EnterpriseLevel",
      "InstanceTypeFamily": "ecs.c7",
      "Cores": 4,
      "Memory": 8
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-12OpenAPI 入参发生变更查看变更详情