You need to enable JavaScript to run this app.
导航

DescribeScalingConfigurations

最近更新时间2024.01.23 17:21:47

首次发布时间2022.05.13 10:42:44

调用 DescribeScalingConfigurations 查询伸缩配置的信息。如果不存在匹配的伸缩配置,则自动忽略,继续查询其他伸缩配置。

请求参数

名字类型是否必填示例值
描述
ActionStringDescribeScalingConfigurations要执行的操作,取值:DescribeScalingConfigurations。
VersionString2020-01-01API的版本,取值为:2020-01-01。
PageNumberInteger1列表的页码,默认值为1。

PageSize

Integer

10

分页查询时每页的行数,取值:1~100。
默认值:10。

ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组的ID。您可以调用DescribeScalingGroups查询伸缩组ID。

ScalingConfigurationIds.N

String

ScalingConfigurationIds.1=
scc-ybmt16auaugh9zfy****&
ScalingConfigurationIds.2=scc-3u0j52ncoi3dllt2****

伸缩配置的ID。取值:

  • 参数 - N:表示伸缩配置的序号,取值:1~10。

ScalingConfigurationNames.N

String

ScalingConfigurationNames.1=
scaling-config-1&
ScalingConfigurationNames.2=
scaling-config-2

伸缩配置的名称:

  • 参数 - N:表示伸缩配置的序号,取值:1~10。

返回数据

名称类型示例值
描述
PageNumberInteger1当前页数。
PageSizeInteger10当前分页的行数。
TotalCountInteger20符合条件的伸缩配置总数。
ScalingConfigurationsArray of struct-符合条件的伸缩配置信息。具体请参见下表“ScalingConfiguration结构”。

ScalingConfiguration结构

名称类型示例值
描述
CreatedAtString2022-04-10T18:29:38+08:00伸缩配置的创建时间。
UpdatedAtString2022-04-14T18:29:38+08:00伸缩配置的更新时间。
VolumesArray of struct-云盘的信息。具体请参见下表“Volume结构”。
HostNameStringinstance-host-name实例主机名。
ImageIdStringimage-ybmihi8jc7l8j1tz****镜像ID。
InstanceDescriptionString云服务器实例实例的描述。
InstanceNameStringinstance-1实例名称。
InstanceTypesList["ecs.c1.xlarge"]实例计算规格。

HpcClusterId

String

hpcCluster-ycdj7d9ios38dfny****

实例所属的高性能计算集群的ID。
仅当伸缩配置中关联了“高性能计算GPU型”时计算规格有返回值。

InstanceChargeType

String

PostPaid

伸缩配置创建实例计费类型。取值:

  • PostPaid:表示按量计费。

SpotStrategy

String

NoSpot

实例的抢占策略。取值:

  • NoSpot:表示创建正常按量付费实例。

  • SpotAsPriceGo:表示创建抢占式实例,即系统自动出价,跟随当前市场实际价格。

KeyPairNameStringkp-test-123密钥对名称。

LifecycleState

String

Active

伸缩配置在伸缩组中的状态,取值:

  • InActive:空闲。
  • Active:已绑定伸缩组。
ScalingConfigurationIdStringscc-ybmt16auaugh9zfy****伸缩配置ID。
ScalingConfigurationNameStringscaling-config-test伸缩配置名称。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩配置所属的伸缩组ID。

SecurityEnhancementStrategy

String

Active

是否开启安全加固,取值:

  • Active:开启安全加固,仅对公共镜像生效。
  • InActive:关闭安全加固,对所有镜像生效。
SecurityGroupIdsList["sg-3ti78x9h8t4bw*****","sg-3cj59ih2v9hj46c6rr******"]实例主网卡关联的安全组ID。

Ipv6AddressCount

Interger

1

是否为实例网卡“分配IPv6地址”。取值:

  • 0:不分配IPv6地址。
  • 1:分配IPv6地址,系统自动为您分配IPv6网段。
ZoneIdStringcn-beijing-a实例所属的可用区ID。
EipStruct-公网IP的详细信息。请参见下文“Eip结构”。
UserDataStringZWNobyBoZWxsbyBlY3Mh实例自定义数据。
ProjectNameStringDefault伸缩配置创建的实例所属项目。
TagsArray of Struct-伸缩配置创建的实例标签信息,具体参见下表"Tag结构"。

Volume结构

名称类型示例值
描述

VolumeType

String

PTSSD

云盘类型,取值:

  • PTSSD:性能型SSD。
  • ESSD_PL0:极速型SSD PL0。

DeleteWithInstance

Boolean

true

云盘是否随实例释放:

  • true:云盘随实例释放。
  • false:云盘不随实例释放。
    取值为false时对系统盘无效,系统盘默认随实例释放,不允许保留。
SizeInteger100云盘容量,单位:GiB。

Eip结构

名称类型示例值
描述

Bandwidth

Integer

1

公网IP的带宽峰值,单位:Mbps。
如果伸缩配置中未设置公网IP,此处返回空值。

ISP

String

BGP

线路类型,取值:

  • BGP:BGP线路。
  • 若您的账号已申请使用静态单线,ISP还可以传入ChinaMobile(表示中国移动)、ChinaTelecom(表示中国电信)、ChinaUnicom(表示中国联通)。
  • 如果伸缩配置中未设置公网IP,此处返回空值。

BillingType

String

PostPaidByBandwidth

公网IP的计费类型,取值:

  • PostPaidByBandwidth:按量计费-按带宽上限计费。
  • PostPaidByTraffic:按量计费-按实际流量计费。
BandwidthPackageIdStringbwp-2zeo05qre24nhrqpy****共享带宽包的ID。

SecurityProtectionTypes

List

AntiDDoS_Enhanced

公网IP的安全防护类型。 取值:

  • AntiDDoS_Enhanced:申请增强防护类型的公网IP(可加入到DDoS原生防护实例)。
  • 无数据则表示基础防护类型的公网IP。

Eip.SecurityProtectionInstanceId

Interger

193

安全防护包的ID。

说明

仅当Eip.SecurityProtectionTypes.N不为空时返回数据。

Tag结构体

名称类型示例值描述
KeyStringk1标签键。
ValueStringv1标签值。

请求示例

GET /?Action=DescribeScalingConfigurations&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220420105132010225094075029A****",
        "Action": "DescribeScalingConfigurations",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "ScalingConfigurations": [
            {
                "CreatedAt": "2022-04-02T08:55:43Z",
                "UpdatedAt": "2022-04-02T17:50:32Z",
                "Volumes": [
                    {
                        "VolumeType": "PTSSD",
                        "Size": 100,
                        "DeleteWithInstance": true
                    }
                ],
                "HostName": "ads",
                "ImageId": "image-ybmihi8jc7l8j1tz****",
                "InstanceDescription": "云服务器实例",
                "InstanceName": "instance-1",
                "InstanceTypes": [
                    "ecs.g1.large"
                ],
                "HpcClusterId": " ",
                "InstanceChargeType": "PostPaid",
                "SpotStrategy": "NoSpot",
                "KeyPairName": "wsh-cd1",
                "LifecycleState": "InActive",
                "ScalingConfigurationId": "scc-ybmt16auaugh9zfy****",
                "ScalingConfigurationName": "scaling-config-test",
                "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",
                "SecurityEnhancementStrategy": "Active",
                "SecurityGroupIds": [
                    "sg-3ti78x9h8t4bw*****"
                ],
                "Ipv6AddressCount": " ",
                "ZoneId": "cn-beijing-a",
                "Eip": {
                    "ISP": "BGP",
                    "Bandwidth": 122,
                    "BillingType": "PostPaidByBandwidth",
                    "BandwidthPackageId": "",
                    "SecurityProtectionTypes": [],
                    "Eip.SecurityProtectionInstanceId": "",
                    
                },
                "UserData": "",
                "ProjectName": "",
                "Tags": ""
            }
        ]
    }
}