You need to enable JavaScript to run this app.
文档中心
弹性伸缩

弹性伸缩

复制全文
下载 pdf
伸缩配置
DescribeScalingConfigurations - 查询伸缩配置列表
复制全文
下载 pdf
DescribeScalingConfigurations - 查询伸缩配置列表
查询伸缩配置的信息。如果不存在匹配的伸缩配置,则自动忽略,继续查询其他伸缩配置。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeScalingConfigurations​
要执行的操作,取值:DescribeScalingConfigurations。​
​
Version string 必选 示例值:2020-01-01​
API的版本,取值:2020-01-01。​
​
ScalingGroupId string 可选 示例值:scg-ybmssdnnhn5pkgyd****​
伸缩组的ID。您可以调用DescribeScalingGroups查询伸缩组ID。​
​
ScalingConfigurationIds.N string[] 可选 示例值:scc-ybmt16auaugh9zfy****​
伸缩配置的ID。取值:​
  • 参数 - N:表示伸缩配置的序号,取值:1~10。​
​
PageNumber integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize integer 可选 示例值:10​
分页查询时每页的行数,取值:1~100。​
默认值:10。​
​
ScalingConfigurationNames.N string[] 可选 示例值:scaling-config-1​
伸缩配置的名称。取值:​
  • 参数 - N:表示伸缩配置的序号,取值:1~10。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
PageNumber integer 示例值:1​
当前页数。​
​
PageSize integer 示例值:10​
当前分页的行数。​
​
ScalingConfigurations object[] 示例值:--​
符合条件的伸缩配置信息。​
HostName string 示例值:instance-host-name​
实例主机名。​
​
ImageId string 示例值:image-ybmihi8jc7l8j1tz****​
镜像ID。​
​
InstanceDescription string 示例值:云服务器实例​
实例的描述。​
​
CreatedAt string 示例值:2022-04-10T18:29:38+08:00​
伸缩配置的创建时间。​
​
Eip object 示例值:--​
公网IP的详细信息。​
ReleaseWithInstance boolean 示例值:true​
公网IP是否随实例删除,仅按量计费公网IP生效。仅按量计费公网IP且在ECS控制台删除实例时生效,在伸缩组中删除实例后公网IP的保留情况请参见实例管理中的详细说明。取值:​
  • true:公网IP随实例删除。​
  • false:公网IP不随实例删除。​
​
Bandwidth integer 示例值:1​
公网IP的带宽峰值,单位:Mbps。​
如果伸缩配置中未设置公网IP,此处返回空值。​
​
BillingType string 示例值:PostPaidByBandwidth​
公网IP的计费类型,取值:​
  • PostPaidByBandwidth:按量计费-按带宽上限计费。​
  • PostPaidByTraffic:按量计费-按实际流量计费。​
​
ISP string 示例值:BGP​
公网IP线路类型,取值:​
  • BGP:BGP线路。​
  • 若您的账号已申请使用静态单线,ISP还可以传入ChinaMobile(表示中国移动)、ChinaTelecom(表示中国电信)、ChinaUnicom(表示中国联通)。​
  • 如果伸缩配置中未设置公网IP,此处返回空值。​
​
BandwidthPackageId string 示例值:bwp-2zeo05qre24nhrqpy****​
共享带宽包的ID。​
​
SecurityProtectionInstanceId integer 示例值:193​
安全防护包的ID。​
说明​
仅当Eip.SecurityProtectionTypes.N不为空时返回数据。​
​
SecurityProtectionTypes string[] 示例值:AntiDDoS_Enhanced​
公网IP的安全防护类型。取值:​
  • AntiDDoS_Enhanced:申请增强防护类型的公网IP(可加入到DDoS原生防护实例)。​
  • 无数据则表示基础防护类型的公网IP。​
​
​
LifecycleState string 示例值:Active​
伸缩配置在伸缩组中的状态,取值:​
  • InActive:空闲。​
  • Active:已绑定伸缩组。​
​
SecurityEnhancementStrategy string 示例值:Active​
是否开启安全加固,取值:​
  • Active:开启安全加固,仅对公共镜像生效。​
  • InActive:关闭安全加固,对所有镜像生效。​
​
ScalingGroupId string 示例值:scc-ybmt16auaugh9zfy****​
伸缩配置ID。​
​
InstanceName string 示例值:instance-1​
实例名称。​
​
InstanceTypes string[] 示例值:ecs.c2i.xlarge​
实例计算规格。​
​
KeyPairName string 示例值:kp-test-123​
密钥对名称。​
​
ScalingConfigurationId string 示例值:scc-ybmt16auaugh9zfy****​
伸缩配置ID。​
​
UpdatedAt string 示例值:2022-04-14T18:29:38+08:00​
伸缩配置的更新时间。​
​
UserData string 示例值:ZWNobyBoZWxsbyBlY3Mh​
实例自定义数据。​
​
ZoneId string 示例值:cn-beijing-a​
实例所属的可用区ID。​
​
Volumes object[] 示例值:--​
云盘的信息。​
ExtraPerformanceTypeId string 示例值:IOPS​
云盘额外性能的类型,仅ESSD FlexPL数据盘支持。关于额外性能的更多介绍,请参见云盘额外性能。​
取值:​
  • Balance:均衡型额外性能。​
  • IOPS:IOPS型额外性能。​
  • Throughput:吞吐量型额外性能。​
​
ExtraPerformanceIOPS integer 示例值:40​
云盘额外IOPS性能大小,仅ESSD FlexPL数据盘支持,单位为次/秒。 ExtraPerformanceTypeId取值为Balance或IOPS时有返回。​
​
ExtraPerformanceThroughputMB integer 示例值:40​
云盘额外吞吐性能大小,仅ESSD FlexPL数据盘支持,单位MB/s。 ExtraPerformanceTypeId取值为Balance或IOPS时有返回。​
​
Size integer 示例值:100​
云盘容量,单位:GiB。​
​
VolumeType string 示例值:ESSD_PL0​
云盘类型,取值:​
  • ESSD_FlexPL:极速型SSD FlexPL。​
  • ESSD_PL0:极速型SSD PL0。​
​
DeleteWithInstance boolean 示例值:true​
云盘是否随实例释放:​
  • true:云盘随实例释放。​
  • false:云盘不随实例释放。​
取值为false时对系统盘无效,系统盘默认随实例释放,不允许保留。​
​
Encrypted boolean 示例值:false​
云盘是否加密,取值:​
  • true:云盘加密。​
  • false:云盘不加密。​
​
KMSKeyId string 示例值:key-​
加密云盘使用的密钥管理服务(KMS)密钥 ID。​
说明​
仅当Encrypted不为空时返回数据。​
​
​
SecurityGroupIds string[] 示例值:sg-3ti78x9h8t4bw*****​
实例主网卡关联的安全组ID列表。​
​
ScalingConfigurationName string 示例值:scaling-config-test​
伸缩配置名称。​
​
HpcClusterId string 示例值:hpcCluster-ycdj7d9ios38dfny****​
实例所属的高性能计算集群的ID。​
仅当伸缩配置中关联了“高性能计算GPU型”时计算规格有返回值。​
​
ProjectName string 示例值:default​
伸缩配置创建的实例所属项目。​
​
InstanceChargeType string 示例值:PostPaid​
伸缩配置创建实例计费类型。取值:​
  • PostPaid:表示按量计费。​
​
SpotStrategy string 示例值:NoSpot​
实例的抢占策略。取值:​
  • NoSpot:表示创建正常按量付费实例。​
  • SpotAsPriceGo:表示系统自动出价,跟随当前市场实际价格的抢占式实例。​
  • SpotWithPriceLimit:表示需要设置出价上限的抢占式实例。​
​
Ipv6AddressCount integer 示例值:0​
是否为实例网卡分配IPv6地址。取值:​
  • 0:不分配IPv6地址。​
  • 1:分配IPv6地址,系统自动为您分配IPv6网段。​
​
Tags object[] 示例值:--​
伸缩配置创建的实例标签信息。​
Key string 示例值:k1​
标签键。​
​
Value string 示例值:v1​
标签值。​
​
​
InstanceTypeOverrides object[] 示例值:--​
抢占式实例的规格信息。​
说明​
仅当SpotStrategy取值为SpotWithPriceLimit时有返回值。​
InstanceType string 示例值:ecs.g2i.large​
抢占式实例的规格。​
​
PriceLimit float 示例值:0.001​
抢占式实例规格每小时的最高价格。​
​
​
​
TotalCount integer 示例值:20​
符合条件的伸缩配置总数。​
​
​
​
请求示例​
​
GET /?Action=DescribeScalingConfigurations&Version=2020-01-01 HTTP/1.1​
Host: auto-scaling.cn-beijing.volcengineapi.com​
X-Date: 20240507T095413Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2024050717541713422813223986CA3B",​
"Version": "2020-01-01",​
"Service": "auto_scaling",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 10,​
"ScalingConfigurations": [​
{​
"Eip": {​
"Bandwidth": 1,​
"BillingType": "PostPaidByBandwidth",​
"ISP": "BGP",​
"BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",​
"SecurityProtectionInstanceId": 193,​
"SecurityProtectionTypes": [​
"AntiDDoS_Enhanced"​
]​
},​
"HostName": "instance-host-name",​
"ImageId": "image-ybmihi8jc7l8j1tz****",​
"InstanceDescription": "云服务器实例",​
"CreatedAt": "2022-04-10T18:29:38+08:00",​
"ScalingConfigurationName": "scaling-config-test\t",​
"SecurityGroupIds": [​
"sg-3ti78x9h8t4bw*****"​
],​
"LifecycleState": "Active",​
"SecurityEnhancementStrategy": "Active",​
"Volumes": [​
{​
"Size": 100,​
"VolumeType": "ESSD_PL0",​
"DeleteWithInstance": true​
}​
],​
"ZoneId": "cn-beijing-a",​
"UserData": "ZWNobyBoZWxsbyBlY3Mh",​
"UpdatedAt": "2022-04-14T18:29:38+08:00",​
"ScalingConfigurationId": "scc-ybmt16auaugh9zfy****",​
"KeyPairName": "kp-test-123\t",​
"InstanceTypes": [​
"ecs.c1.xlarge"​
],​
"InstanceName": "instance-1",​
"ScalingGroupId": "scc-ybmt16auaugh9zfy****",​
"HpcClusterId": "hpcCluster-ycdj7d9ios38dfny****",​
"ProjectName": "default",​
"InstanceChargeType": "PostPaid",​
"SpotStrategy": "NoSpot",​
"Ipv6AddressCount": 0,​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
},​
],​
"InstanceTypeOverrides": [​
{​
"InstanceType": "ecs.g2i.large",​
"PriceLimit": 0.001​
}​
]​
},​
],​
"TotalCount": 20​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
LimitExceeded.ScalingConfigurationIds​
You've reached the limit on the number of ScalingConfigurationIds.​
已达到伸缩配置ID数量上限。​
400​
LimitExceeded.ScalingConfigurationNames​
You've reached the limit on the number of ScalingConfigurationName.​
已达到伸缩配置名称数量上限。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.09.11 19:17:02
这个页面对您有帮助吗?
有用
有用
无用
无用