全部产品
Search
文档中心

弹性伸缩:DescribeScalingConfigurations - 查询ECS类型伸缩配置信息

更新时间:Nov 11, 2024

调用API DescribeScalingConfigurations查询ECS类型伸缩配置的信息,包括实例规格、镜像等信息,方便您提前了解弹性扩张时使用的ECS实例模板详情。

调试

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

授权信息

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

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

请求参数

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

伸缩配置所属伸缩组的地域 ID。

cn-qingdao
PageNumberinteger

伸缩配置列表的页码,起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数,最大值:50。

默认值:10。

50
ScalingGroupIdstring

伸缩组的 ID,您可以查询该伸缩组下所有的伸缩配置。

asg-bp17pelvl720x3v7****
ScalingConfigurationIdsarray

待查询伸缩配置的 ID。

查询结果包括生效和未生效的伸缩配置,并通过返回参数LifecycleState进行标识。

string

待查询伸缩配置的 ID。

查询结果包括生效和未生效的伸缩配置,并通过返回参数LifecycleState进行标识。

asc-bp17pelvl720x5ub****
ScalingConfigurationNamesarray

待查询伸缩配置的名称。

查询结果会忽略失效的伸缩配置名称,并且不报错。

string

待查询伸缩配置的名称。

查询结果会忽略失效的伸缩配置名称,并且不报错。

scalingcon****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberinteger

当前页码。

1
PageSizeinteger

每页行数。

50
TotalCountinteger

伸缩配置的总数。

1
ScalingConfigurationsarray<object>

伸缩配置信息的集合。

ScalingConfigurationobject

伸缩配置信息的集合。

DeploymentSetIdstring

ECS 实例所属的部署集的 ID。

ds-bp1frxuzdg87zh4p****
CreationTimestring

伸缩配置的创建时间。

2014-08-14T10:58Z
ScalingConfigurationNamestring

伸缩配置的名称。

scalingconfigura****
SystemDiskDescriptionstring

系统盘的描述。

Test system disk.
KeyPairNamestring

登录 ECS 实例时使用的密钥对的名称。

keypair****
SecurityGroupIdstring

ECS 实例所属的安全组的 ID,同一个安全组内的 ECS 实例可以互相访问。

sg-bp18kz60mefs****
PrivatePoolOptions.Idstring

私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。

eap-bp67acfmxazb4****
SystemDiskAutoSnapshotPolicyIdstring

系统盘使用的自动快照策略 ID。

sp-bp12m37ccmxvbmi5****
SpotStrategystring

后付费实例的抢占策略。可能值:

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

伸缩配置所属伸缩组的 ID。

asg-bp17pelvl720x3v7****
Affinitystring

专有宿主机实例是否与专有宿主机关联。可能值:

  • default:实例不与专有宿主机关联。已启用节省停机模式的实例,停机后再次启动时,若原专有宿主机可用资源不足,则实例被放置在自动部署资源池的其它专有宿主机上。

  • host:实例与专有宿主机关联。已启用节省停机模式的实例,停机后再次启动时,仍放置在原专有宿主机上。若原专有宿主机可用资源不足,则实例重启失败。

default
Tenancystring

是否在专有宿主机上创建实例。可能值:

  • default:创建非专有宿主机实例。

  • host:创建专有宿主机实例。若您不指定 DedicatedHostId,则由阿里云自动选择专有宿主机放置实例。

默认值:default。

default
SystemDiskSizeinteger

系统盘的磁盘大小。单位为 GiB。

100
Ipv6AddressCountinteger

为弹性网卡指定随机生成的 IPv6 地址数量。

1
SpotDurationinteger

抢占式实例的保留时长,单位为小时。

1
LifecycleStatestring

伸缩配置在伸缩组中的状态。可能值:

  • Active:生效状态。伸缩组会使用处于生效状态的伸缩配置自动创建 ECS 实例。
  • Inacitve:未生效状态。处于未生效状态的伸缩配置存在于伸缩组中,但伸缩组不会使用此类伸缩配置自动创建 ECS 实例。
Active
InstanceNamestring

ECS 实例的名称。

instance****
SecurityEnhancementStrategystring

是否开启安全加固。可能值:

  • Active:启用安全加固,只对公共镜像生效。
  • Deactive:不启用安全加固,对所有镜像类型生效。
Active
UserDatastring

ECS 实例的自定义数据。

echo hello ecs!
PrivatePoolOptions.MatchCriteriastring

实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。可能值:

  • Open:开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。

  • Target:指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。

  • None:不使用模式。实例启动将不使用私有池容量。

Open
DedicatedHostIdstring

是否在专有宿主机上创建 ECS 实例。由于专有宿主机不支持创建抢占式实例,指定 DedicatedHostId 参数后,会自动忽略请求中的 SpotStrategy 和 SpotPriceLimit 设置。

您可以通过调用 DescribeDedicatedHosts 接口查询专有宿主机 ID 列表。

dh-bp67acfmxazb4p****
InstanceGenerationstring

ECS 实例的系列。

ecs-3
HpcClusterIdstring

ECS 实例所属的 HPC 集群的 ID。

hpc-clus****
PasswordInheritboolean

是否使用镜像预设的密码。

true
Memoryinteger

内存大小,单位为 GiB。

同时指定 CPU 和 Memory 可以定义实例规格范围。例如,CPU=2 且 Memory=16 可以定义配置为 2 vCPU 和 16 GiB 的所有实例规格。弹性伸缩会结合 IO 优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。

说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。
16
ImageIdstring

镜像文件 ID,自动创建实例时使用的镜像资源。

centos6u5_64_20G_aliaegis_2014****.vhd
ImageFamilystring

镜像族系名称,通过设置该参数来获取当前镜像族系内最新的可用镜像,用于创建实例。如果已经设置了参数ImageId,则不能设置该参数。

hangzhou-daily-update
ImageOwnerAliasstring

镜像来源。可能值:

  • system:阿里云提供的公共镜像。
  • self:您创建的自定义镜像。
  • others:其他阿里云用户提供的共享镜像或社区镜像。
  • marketplace:云市场镜像提供的镜像。
system
LoadBalancerWeightinteger

ECS 实例作为后端服务器时的权重,取值范围:1~100。

1
SystemDiskCategorystring

系统盘的磁盘种类。可能值:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • ephemeral_ssd:本地 SSD 盘。
  • cloud_essd:ESSD 云盘。
  • cloud_auto:ESSD AutoPL 云盘。
cloud
HostNamestring

云服务器的主机名。

LocalHost
SystemDiskNamestring

系统盘的名称。

cloud_ssd_Test
InternetMaxBandwidthOutinteger

公网出带宽最大值,单位为 Mbit/s。

10
InternetMaxBandwidthIninteger

公网入带宽最大值,单位为 Mbit/s。

10
InstanceTypestring

ECS 实例的实例规格。

ecs.g6.large
InstanceDescriptionstring

ECS 实例的描述。

FinanceDept
IoOptimizedstring

是否为 I/O 优化实例。可能值:

  • none:非 I/O 优化。
  • optimized:I/O 优化。
none
RamRoleNamestring

ECS 实例的 RAM 角色名称。RAM 角色名称由 RAM 提供和维护,您可调用 ListRoles 查询可用的 RAM 角色。

ramrole****
SystemDiskPerformanceLevelstring

当系统盘为 ESSD 云盘时,ESSD 云盘的性能等级。

PL1
Cpuinteger

vCPU 个数。

同时指定 CPU 和 Memory 可以定义实例规格范围,例如,CPU=2 且 Memory=16 可以定义配置为 2 vCPU 和 16 GiB 的所有实例规格。弹性伸缩会结合 IO 优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。

说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。
2
ResourceGroupIdstring

ECS 实例所属资源组的 ID。

rg-aekzn2ou7xo****
ZoneIdstring

实例所属的可用区 ID,您可以调用 DescribeZones 获取可用区列表。

cn-hangzhou-g
InternetChargeTypestring

网络计费类型。可能值:

  • PayByBandwidth:按带宽计费。此时 InternetMaxBandwidthOut 即为所选的固定带宽值。
  • PayByTraffic:按流量计费。此时 InternetMaxBandwidthOut 只是一个带宽上限,计费以实际产生的网络流量为依据。
PayByTraffic
ImageNamestring

镜像文件名称。

centos6u5_64_20G_aliaegis_2014****.vhd
ScalingConfigurationIdstring

伸缩配置的 ID。

asc-bp1ezrfgoyn5kijl****
CreditSpecificationstring

突发性能实例的运行模式。可能值:

Standard
SpotInterruptionBehaviorstring

抢占实例中断模式。

Terminate
CustomPrioritiesarray<object>

ECS 实例规格+交换机的自定义优先级。

注意 仅在伸缩组的扩缩容策略为优先级策略时有效。

当无法根据优先级较高的实例规格+交换机创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格+交换机组合来创建实例。

说明 如果仅指定了部分实例规格+交换机的自定义优先级,则未指定的部分优先级低于指定的部分,且未指定部分仍会依次按照伸缩组的交换机顺序、伸缩配置的实例规格顺序确定优先级。
  • 例如:伸缩组的交换机顺序为 vsw1、vsw2,伸缩配置的实例规格顺序为 type1、type2,自定义优先级顺序为["vsw2+type2", "vsw1+type2"],则最终优先级为:"vsw2+type2" > "vsw1+type2" > "vsw1+type1" > "vsw2+type1"
  • CustomPriorityobject
    InstanceTypestring

    ECS 实例的实例规格。

    ecs.c6a.4xlarge
    VswitchIdstring

    虚拟交换机的 ID。

    vsw-bp14zolna43z266bq****
    DataDisksarray<object>

    数据盘信息的集合。

    DataDiskobject

    数据盘信息的集合。

    PerformanceLevelstring

    当数据盘为 ESSD 云盘时,ESSD 云盘的性能等级。

    PL1
    Descriptionstring

    数据盘的描述。

    FinanceDept
    SnapshotIdstring

    创建数据盘使用的快照 ID。

    s-23f2i****
    Devicestring

    数据盘的挂载点。

    /dev/xvdb
    Sizeinteger

    数据盘的磁盘大小,内存单位为 GiB。可能值:

    • cloud:5~2000。
    • cloud_efficiency:20~32768。
    • cloud_ssd:20~32768。
    • cloud_essd:20~32768。
    • ephemeral_ssd:5~800。
    200
    DiskNamestring

    数据盘的名称。

    cloud_ssdData
    AutoSnapshotPolicyIdstring

    数据盘使用的自动快照策略 ID。

    sp-bp19nq9enxqkomib****
    Categorystring

    数据盘的磁盘种类。可能值:

    • cloud:普通云盘。随实例创建的普通云盘的 DeleteWithInstance 属性为 true。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD 云盘。
    • ephemeral_ssd:本地 SSD 盘。
    • cloud_essd:ESSD 云盘。
    • cloud_auto:ESSD AutoPL 云盘。
    cloud
    KMSKeyIdstring

    数据盘对应的 KMS 密钥的 ID。

    0e478b7a-4262-4802-b8cb-00d3fb40****
    DeleteWithInstanceboolean

    数据盘是否随实例释放。可能值:

    • true:释放实例时,该磁盘随实例一起释放。
    • false:释放实例时,该磁盘保留不释放。
    true
    Encryptedstring

    数据盘是否加密。可能值:

    • true:加密。
    • false:不加密。

    默认值:false。

    false
    Categoriesarray

    数据盘的多磁盘类型。第一个磁盘类型优先级最高,其他磁盘类型的优先级依次递减。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。可能值:

    • cloud:普通云盘。随实例创建的普通云盘的 DeleteWithInstance 属性为 true。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD 云盘。
    • cloud_essd:ESSD 云盘。
    Categorystring

    数据盘的多磁盘类型。第一个磁盘类型优先级最高,其他磁盘类型的优先级依次递减。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。可能值:

    • cloud:普通云盘。随实例创建的普通云盘的 DeleteWithInstance 属性为 true。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD 云盘。
    • cloud_essd:ESSD 云盘。
    cloud_essd
    ProvisionedIopslong

    数据盘预配置的 IOPS(Input/Output Operations Per Second)性能指标。

    说明 IOPS(Input/Output Operations Per Second)指每秒能处理的 I/O 个数,表示块存储处理读写(输出/输入)的能力,单位为次。
    100
    BurstingEnabledboolean

    数据盘是否开启 Burst(性能突发)。可能值:

    • true:开启。
    • false:未开启。
    说明 DataDisk.Category取值为cloud_auto时才显示该参数。
    false
    Tagsarray<object>

    标签信息的集合。

    Tagobject

    标签信息的集合。

    Keystring

    实例的标签键。N 的取值范围:1~20。

    如果传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

    binary
    Valuestring

    实例的标签值。N 的取值范围:1~20。

    如果传入该值,则允许为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

    alterTable
    SpotPriceLimitsarray<object>

    抢占式实例信息的集合。

    SpotPriceModelobject

    抢占式实例信息的集合。

    InstanceTypestring

    抢占式实例的实例规格。

    ecs.g6.large
    PriceLimitfloat

    抢占式实例对应的出价。

    0.125
    InstancePatternInfosarray<object>

    智能配置的信息集合,用于筛选符合要求的实例规格范围。

    InstancePatternInfoobject

    智能配置的信息集合,用于筛选符合要求的实例规格范围。

    MaxPricefloat

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

    2
    Coresinteger

    实例规格的 vCPU 内核数目。

    2
    Memoryfloat

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

    4
    InstanceFamilyLevelstring

    实例规格族级别。

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

    实例规格所属的架构类型。可能值:

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

    实例规格所属的架构类型。可能值:

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

    是否为性能突发实例规格。可能值:

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

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

    • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
    • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
    ExcludedInstanceTypestring

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

    • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
    • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
    ecs.n1.small/ecs.n1.*/*7*
    InstanceTypeFamiliesarray

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

    InstanceTypeFamilystring

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

    ecs.g6
    MinimumCpuCoreCountinteger

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

    2
    MaximumCpuCoreCountinteger

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

    说明 MaximumCpuCoreCount 不支持超过 MinimumCpuCoreCount 的 4 倍。
    4
    GpuSpecsarray

    GPU 类型。

    GpuSpecstring

    GPU 类型。

    NVIDIA V100
    InstanceCategoriesarray

    实例分类。可能值:

    说明 N 表示可以设置多个实例分类,N 的取值范围:1~10。
    • 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:高性能计算型。
    InstanceCategorystring

    实例分类。可能值:

    说明 N 表示可以设置多个实例分类,N 的取值范围:1~10。
    • 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。
    CpuArchitecturestring

    实例的 CPU 架构。可能值:

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

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

    PhysicalProcessorModelstring

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

    Intel Xeon(Ice Lake) Platinum 8369B
    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
    SystemDiskCategoriesarray

    系统盘的多磁盘类型。第一个磁盘类型优先级最高,其他磁盘类型的优先级依次递减。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。可能值:

    • cloud:普通云盘。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD 云盘。
    • cloud_essd:ESSD 云盘。
    SystemDiskCategorystring

    系统盘的多磁盘类型。第一个磁盘类型优先级最高,其他磁盘类型的优先级依次递减。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。可能值:

    • cloud:普通云盘。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD 云盘。
    • cloud_essd:ESSD 云盘。
    cloud
    WeightedCapacitiesarray

    对应指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。

    WeightedCapacityinteger

    对应指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。

    4
    InstanceTypesarray

    ECS 实例的实例规格的集合。

    InstanceTypestring

    ECS 实例的实例规格的集合。

    ecs.g6.large
    SecurityGroupIdsarray

    ECS 实例所属的多个安全组的 ID,同一个安全组内的 ECS 实例可以互相访问。

    SecurityGroupIdstring

    ECS 实例所属的多个安全组的 ID,同一个安全组内的 ECS 实例可以互相访问。

    sg-bp18kz60mefs****
    SchedulerOptionsobject
    说明 该参数正在邀测中,暂未开放使用。
    ManagedPrivateSpaceIdstring
    说明 该参数正在邀测中,暂未开放使用。
    testManagedPrivateSpaceId
    SystemDiskEncryptedboolean

    系统盘是否加密。可能值:

    • true:加密。

    • false:不加密。

    false
    SystemDiskKMSKeyIdstring

    系统盘使用的 KMS 密钥 ID。

    0e478b7a-4262-4802-b8cb-00d3fb40****
    SystemDiskEncryptAlgorithmstring

    系统盘采用的加密算法。可能值:

    • AES-256。

    • SM4-128。

    AES-256
    SystemDiskProvisionedIopslong

    系统盘预配置的 IOPS(Input/Output Operations Per Second)性能指标。

    说明 IOPS(Input/Output Operations Per Second)指每秒能处理的 I/O 个数,表示块存储处理读写(输出/输入)的能力,单位为次。
    100
    SystemDiskBurstingEnabledboolean

    系统盘是否开启 Burst(性能突发)。可能值:

    • true:开启。
    • false:未开启。
    说明 当 SystemDisk.Category 取值为 cloud_auto 时才支持设置该参数。
    false
    ImageOptionsLoginAsNonRootboolean

    ECS 实例是否使用 ecs-user 用户登录。可能值:

    • true:是。
    • false:否。
    false
    DeletionProtectionboolean

    实例释放保护属性,指定是否支持通过 ECS 控制台或 API(DeleteInstance)直接释放实例。可能值:

    • true:开启实例释放保护,无法通过 ECS 控制台或者或 API(DeleteInstance)直接释放实例。

    • false:关闭实例释放保护,可以通过 ECS 控制台或者或 API(DeleteInstance)直接释放实例。

    说明 该属性仅适用于按量付费实例,防止弹性伸缩扩容的实例被误删除,不影响正常的缩容活动,开启实例释放保护的实例可以被缩容活动释放掉。
    false
    StorageSetIdstring

    存储集 ID。

    ss-bp67acfmxazb4p****
    StorageSetPartitionNumberinteger

    存储集中的最大分区数量。取值为大于等于 2 的整数。

    2
    NetworkInterfacesarray<object>

    弹性网卡列表。

    NetworkInterfaceobject

    弹性网卡。

    InstanceTypestring

    弹性网卡类型。可能值:

    • Primary:主网卡。

    • Secondary:辅助弹性网卡。

    Primary
    NetworkInterfaceTrafficModestring

    弹性网卡的通讯模式。可能值:

    • Standard:使用 TCP 通讯模式。
    • HighPerformance:开启 ERI(Elastic RDMA Interface)接口,使用 RDMA 通讯模式。
    HighPerformance
    Ipv6AddressCountinteger

    为主网卡指定随机生成的 IPv6 地址数量。

    1
    SecurityGroupIdsarray

    弹性网卡所属的一个或多个安全组 ID。

    SecurityGroupIdstring

    弹性网卡所属的一个或多个安全组 ID。

    sg-2vc3e1v7xxxxx
    DedicatedHostClusterIdstring

    专有宿主机集群 ID。

    dc-zm04u8r3lohsq****
    PasswordSettedboolean

    是否设置实例密码。可能值:

    • true:设置实例密码
    • false:不设置实例密码
    false
    SecurityOptionsobject

    安全选项。

    ConfidentialComputingModestring

    机密计算模式。可能值:

    TDX
    HttpEndpointstring

    是否启用实例元数据的访问通道。可能值:

    • enabled:启用。
    • disabled:禁用。
    enabled
    HttpTokensstring

    访问实例元数据时是否强制使用加固模式(IMDSv2)。可能值:

    • optional:不强制使用。
    • required:强制使用。设置该取值后,普通模式无法访问实例元数据。
    optional

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
      "PageNumber": 1,
      "PageSize": 50,
      "TotalCount": 1,
      "ScalingConfigurations": [
        {
          "DeploymentSetId": "ds-bp1frxuzdg87zh4p****",
          "CreationTime": "2014-08-14T10:58Z",
          "ScalingConfigurationName": "scalingconfigura****",
          "SystemDiskDescription": "Test system disk.",
          "KeyPairName": "keypair****",
          "SecurityGroupId": "sg-bp18kz60mefs****",
          "PrivatePoolOptions.Id": "eap-bp67acfmxazb4****",
          "SystemDiskAutoSnapshotPolicyId": "sp-bp12m37ccmxvbmi5****",
          "SpotStrategy": "NoSpot",
          "ScalingGroupId": "asg-bp17pelvl720x3v7****",
          "Affinity": "default",
          "Tenancy": "default",
          "SystemDiskSize": 100,
          "Ipv6AddressCount": 1,
          "SpotDuration": 1,
          "LifecycleState": "Active",
          "InstanceName": "instance****",
          "SecurityEnhancementStrategy": "Active",
          "UserData": "echo hello ecs!\t\n",
          "PrivatePoolOptions.MatchCriteria": "Open",
          "DedicatedHostId": "dh-bp67acfmxazb4p****",
          "InstanceGeneration": "ecs-3",
          "HpcClusterId": "hpc-clus****",
          "PasswordInherit": true,
          "Memory": 16,
          "ImageId": "centos6u5_64_20G_aliaegis_2014****.vhd",
          "ImageFamily": "hangzhou-daily-update",
          "ImageOwnerAlias": "system",
          "LoadBalancerWeight": 1,
          "SystemDiskCategory": "cloud",
          "HostName": "LocalHost",
          "SystemDiskName": "cloud_ssd_Test",
          "InternetMaxBandwidthOut": 10,
          "InternetMaxBandwidthIn": 10,
          "InstanceType": "ecs.g6.large",
          "InstanceDescription": "FinanceDept",
          "IoOptimized": "none",
          "RamRoleName": "ramrole****",
          "SystemDiskPerformanceLevel": "PL1",
          "Cpu": 2,
          "ResourceGroupId": "rg-aekzn2ou7xo****",
          "ZoneId": "cn-hangzhou-g",
          "InternetChargeType": "PayByTraffic",
          "ImageName": "centos6u5_64_20G_aliaegis_2014****.vhd\t\n",
          "ScalingConfigurationId": "asc-bp1ezrfgoyn5kijl****",
          "CreditSpecification": "Standard",
          "SpotInterruptionBehavior": "Terminate",
          "CustomPriorities": [
            {
              "InstanceType": "ecs.c6a.4xlarge",
              "VswitchId": "vsw-bp14zolna43z266bq****\n"
            }
          ],
          "DataDisks": [
            {
              "PerformanceLevel": "PL1",
              "Description": "FinanceDept",
              "SnapshotId": "s-23f2i****",
              "Device": "/dev/xvdb",
              "Size": 200,
              "DiskName": "cloud_ssdData",
              "AutoSnapshotPolicyId": "sp-bp19nq9enxqkomib****",
              "Category": "cloud",
              "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
              "DeleteWithInstance": true,
              "Encrypted": "false",
              "Categories": [
                "cloud_essd"
              ],
              "ProvisionedIops": 100,
              "BurstingEnabled": false
            }
          ],
          "Tags": [
            {
              "Key": "binary",
              "Value": "alterTable"
            }
          ],
          "SpotPriceLimits": [
            {
              "InstanceType": "ecs.g6.large\t\n",
              "PriceLimit": 0.125
            }
          ],
          "InstancePatternInfos": [
            {
              "MaxPrice": 2,
              "Cores": 2,
              "Memory": 4,
              "InstanceFamilyLevel": "EnterpriseLevel",
              "Architectures": [
                "X86"
              ],
              "BurstablePerformance": "Include",
              "ExcludedInstanceTypes": [
                "ecs.n1.small/ecs.n1.*/*7*"
              ],
              "InstanceTypeFamilies": [
                "ecs.g6"
              ],
              "MinimumCpuCoreCount": 2,
              "MaximumCpuCoreCount": 4,
              "GpuSpecs": [
                "NVIDIA V100"
              ],
              "InstanceCategories": [
                "Compute-optimized with GPU"
              ],
              "CpuArchitectures": [
                "X86"
              ],
              "PhysicalProcessorModels": [
                "Intel Xeon(Ice Lake) Platinum 8369B"
              ],
              "MinimumEniQuantity": 2,
              "MinimumEniPrivateIpAddressQuantity": 2,
              "MinimumEniIpv6AddressQuantity": 1,
              "MinimumInitialCredit": 12,
              "MinimumBaselineCredit": 12,
              "MinimumMemorySize": 4,
              "MaximumMemorySize": 4,
              "MinimumGpuAmount": 2,
              "MaximumGpuAmount": 2
            }
          ],
          "SystemDiskCategories": [
            "cloud"
          ],
          "WeightedCapacities": [
            4
          ],
          "InstanceTypes": [
            "ecs.g6.large"
          ],
          "SecurityGroupIds": [
            "sg-bp18kz60mefs****"
          ],
          "SchedulerOptions": {
            "ManagedPrivateSpaceId": "testManagedPrivateSpaceId"
          },
          "SystemDiskEncrypted": false,
          "SystemDiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****\t\n",
          "SystemDiskEncryptAlgorithm": "AES-256\t\n",
          "SystemDiskProvisionedIops": 100,
          "SystemDiskBurstingEnabled": false,
          "ImageOptionsLoginAsNonRoot": false,
          "DeletionProtection": false,
          "StorageSetId": "ss-bp67acfmxazb4p****",
          "StorageSetPartitionNumber": 2,
          "NetworkInterfaces": [
            {
              "InstanceType": "Primary",
              "NetworkInterfaceTrafficMode": "HighPerformance",
              "Ipv6AddressCount": 1,
              "SecurityGroupIds": [
                "sg-2vc3e1v7xxxxx"
              ]
            }
          ],
          "DedicatedHostClusterId": "dc-zm04u8r3lohsq****",
          "PasswordSetted": false,
          "SecurityOptions": {
            "ConfidentialComputingMode": "TDX"
          },
          "HttpEndpoint": "enabled",
          "HttpTokens": "optional"
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-11-08OpenAPI 返回结构发生变更查看变更详情
    2024-10-10OpenAPI 返回结构发生变更查看变更详情
    2024-06-12OpenAPI 返回结构发生变更查看变更详情
    2024-04-23OpenAPI 返回结构发生变更查看变更详情
    2024-03-20OpenAPI 返回结构发生变更查看变更详情
    2024-01-29OpenAPI 返回结构发生变更查看变更详情
    2023-11-24OpenAPI 返回结构发生变更查看变更详情
    2023-08-23OpenAPI 返回结构发生变更查看变更详情
    2023-04-12OpenAPI 返回结构发生变更查看变更详情