文档

DescribePatternTypes

使用指定实例属性方式配置伸缩配置时,调用API DescribePatternTypes接口根据指定实例的vCPU核数、内存大小、规格族级别以及可接受的最高价格等属性,筛选出符合要求的实例规格。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribePatternTypes

系统规定参数。取值:DescribePatternTypes

RegionId String cn-hangzhou

所属地域ID。

VSwitchId.N String vsw-bp14zolna43z266bq****

交换机的ID。

SpotStrategy String NoSpot

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

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

默认值:NoSpot。

Cores Integer 2

实例规格的vCPU内核数目。

Memory Float 4

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

MaxPrice Float 2

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

InstanceFamilyLevel String EnterpriseLevel

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

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

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

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

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

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

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

BurstablePerformance String Include

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

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

默认值:Include。

CoresList.N Integer 2

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

MemoryList.N Float 4

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

ChannelId Long 79425074

渠道ID。

说明 该参数不对外开放(仅为内部保留参数)。

返回数据

名称

类型

示例值

描述

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

PatternTypes Array of PatternType

符合条件的实例规格。

InstanceType String ecs.c7.xlarge

实例规格名称。

InstanceFamilyLevel String EnterpriseLevel

实例规格族级别。可能值:

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

实例规格族。

Cores Integer 4

实例规格的vCPU核数。

Memory Float 8

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

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribePatternTypes
&RegionId=cn-hangzhou
&VSwitchId=["vsw-bp14zolna43z266bq****"]
&SpotStrategy=NoSpot
&Cores=2
&Memory=4.0
&MaxPrice=2.0
&InstanceFamilyLevel=EnterpriseLevel
&ExcludedInstanceType=["ecs.c6.xlarge"]
&Architecture=["X86"]
&BurstablePerformance=Include
&CoresList=[2]
&MemoryList=[4.0]
&ChannelId=79425074
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePatternTypesResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PatternTypes>
        <InstanceType>ecs.c7.xlarge</InstanceType>
        <InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>
        <InstanceTypeFamily>ecs.c7</InstanceTypeFamily>
        <Cores>4</Cores>
        <Memory>8</Memory>
    </PatternTypes>
</DescribePatternTypesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

  • 本页导读