diff options
Diffstat (limited to 'data/en_us/ess/2014-08-28')
| -rw-r--r-- | data/en_us/ess/2014-08-28/api-docs.php | 24594 |
1 files changed, 24594 insertions, 0 deletions
diff --git a/data/en_us/ess/2014-08-28/api-docs.php b/data/en_us/ess/2014-08-28/api-docs.php new file mode 100644 index 0000000..4185384 --- /dev/null +++ b/data/en_us/ess/2014-08-28/api-docs.php @@ -0,0 +1,24594 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Ess', + 'version' => '2014-08-28', + ], + 'directories' => [ + [ + 'id' => 63491, + 'title' => 'Scaling groups', + 'type' => 'directory', + 'children' => [ + 'CreateScalingGroup', + 'DeleteScalingGroup', + 'ModifyScalingGroup', + 'EnableScalingGroup', + 'DisableScalingGroup', + 'SetGroupDeletionProtection', + 'AttachLoadBalancers', + 'DetachLoadBalancers', + 'DetachDBInstances', + 'AttachDBInstances', + 'AttachVServerGroups', + 'DetachVServerGroups', + 'DescribeScalingGroups', + 'DescribeScalingInstances', + 'DescribeScalingActivities', + 'DescribeScalingActivityDetail', + 'DescribeLimitation', + 'DescribeElasticStrength', + 'VerifyAuthentication', + 'SuspendProcesses', + 'ResumeProcesses', + 'VerifyUser', + ], + ], + [ + 'id' => 63513, + 'title' => 'Scaling configurations', + 'type' => 'directory', + 'children' => [ + 'CreateScalingConfiguration', + 'DeleteScalingConfiguration', + 'ModifyScalingConfiguration', + 'DescribeScalingConfigurations', + 'DeactivateScalingConfiguration', + ], + ], + [ + 'id' => 63519, + 'title' => 'Scaling rules', + 'type' => 'directory', + 'children' => [ + 'CreateScalingRule', + 'DeleteScalingRule', + 'ModifyScalingRule', + 'DescribeScalingRules', + ], + ], + [ + 'id' => 63524, + 'title' => 'Scaling tasks', + 'type' => 'directory', + 'children' => [ + 'AttachInstances', + 'DetachInstances', + 'ExecuteScalingRule', + 'RemoveInstances', + ], + ], + [ + 'id' => 63529, + 'title' => 'Scheduled tasks', + 'type' => 'directory', + 'children' => [ + 'CreateScheduledTask', + 'DeleteScheduledTask', + 'ModifyScheduledTask', + 'DescribeScheduledTasks', + ], + ], + [ + 'id' => 63534, + 'title' => 'Lifecycle hooks', + 'type' => 'directory', + 'children' => [ + 'CreateLifecycleHook', + 'DeleteLifecycleHook', + 'ModifyLifecycleHook', + 'DescribeLifecycleActions', + 'DescribeLifecycleHooks', + 'RecordLifecycleActionHeartbeat', + 'CompleteLifecycleAction', + ], + ], + [ + 'id' => 63542, + 'title' => 'Event notifications', + 'type' => 'directory', + 'children' => [ + 'CreateNotificationConfiguration', + 'DeleteNotificationConfiguration', + 'ModifyNotificationConfiguration', + 'DescribeNotificationConfigurations', + 'DescribeNotificationTypes', + ], + ], + [ + 'id' => 63548, + 'title' => 'Instances', + 'type' => 'directory', + 'children' => [ + 'SetInstancesProtection', + 'SetInstanceHealth', + 'EnterStandby', + 'ExitStandby', + 'RebalanceInstances', + ], + ], + [ + 'id' => 63554, + 'title' => 'Regions', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 63556, + 'title' => 'Tags', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'ListTagKeys', + 'ListTagValues', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 63562, + 'title' => 'Event-triggered tasks', + 'type' => 'directory', + 'children' => [ + 'CreateAlarm', + 'DeleteAlarm', + 'DisableAlarm', + 'EnableAlarm', + 'ModifyAlarm', + 'DescribeAlarms', + ], + ], + [ + 'id' => 165918, + 'title' => '未翻译(其他)', + 'type' => 'directory', + 'children' => [ + 'AttachAlbServerGroups', + 'CreateEciScalingConfiguration', + 'DeleteEciScalingConfiguration', + 'DescribeEciScalingConfigurations', + 'DetachAlbServerGroups', + 'ModifyEciScalingConfiguration', + 'ScaleWithAdjustment', + 'ChangeResourceGroup', + 'AttachServerGroups', + 'DetachServerGroups', + 'ModifyInstanceAttribute', + 'DescribePatternTypes', + 'ApplyScalingGroup', + 'ModifyAlertConfiguration', + 'DescribeAlertConfiguration', + 'SuspendInstanceRefresh', + 'ResumeInstanceRefresh', + 'CancelInstanceRefresh', + 'DescribeInstanceRefreshes', + 'RollbackInstanceRefresh', + 'StartInstanceRefresh', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateScalingGroup' => [ + 'summary' => ' 创建一个伸缩组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92658', + 'abilityTreeNodes' => [ + 'FEATUREessGIWHSQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling group. The name of each scaling group must be unique in a region. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n" + ."\n" + .'If you do not specify this parameter, the value of the **ScalingGroupId **parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'LaunchTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the launch template that provides instance configurations for Auto Scaling to create instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lt-m5e3ofjr1zn1aw7****', + ], + ], + [ + 'name' => 'LaunchTemplateVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the launch template. Valid values:'."\n" + ."\n" + .'* A fixed template version number.'."\n" + .'* Default: the default template version.'."\n" + .'* Latest: the latest template version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of an existing ECS instance that provides instance configurations for Auto Scaling to create a scaling configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-28wt4****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group. For more information, see the [Regions and zones](~~40654~~) topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'MinSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of ECS instances that must be contained in the scaling group. If the number of ECS instances in the scaling group is less than the value of the `MinSize` parameter, Auto Scaling automatically creates ECS instances until the number of instances in the scaling group is equal to the minimum number.'."\n" + ."\n" + .'> The value of the `MinSize` parameter must be less than or equal to the value of the `MaxSize` parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'MaxSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of ECS instances that can be contained in the scaling group. If the number of ECS instances in the scaling group is greater than the value of the `MaxSize` parameter, Auto Scaling automatically removes ECS instances until the number of instances in the scaling group is equal to the maximum number.'."\n" + ."\n" + .'The value range of the **MaxSize** parameter varies based on the instance quota. You can go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the maximum number of instances that a scaling group can contain.'."\n" + ."\n" + .'For example, if a scaling group can contain up to 2,000 instances, the value range of the `MaxSize` parameter is 0 to 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'DefaultCooldown', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cooldown period after a scaling activity is complete. Valid values: 0 to 86400. Unit: seconds.'."\n" + ."\n" + .'During the cooldown period, Auto Scaling executes only scaling activities that are triggered by CloudMonitor event-triggered tasks.'."\n" + ."\n" + .'Default value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'LoadBalancerIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the CLB instances that you want to associate with the scaling group. The value can be a JSON array that contains multiple CLB instance IDs. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'You can associate only a limited number of CLB instances with a scaling group. Go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the maximum number of CLB instances that you can associate with a scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["lb-bp1u7etiogg38yvwz****", "lb-bp168cqrux9ai9l7f****", "lb-bp1jv3m9zvj22ufxp****"]', + ], + ], + [ + 'name' => 'DBInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the ApsaraDB RDS instances that you want to associate with the scaling group. The value can be a JSON array that contains multiple ApsaraDB RDS instance IDs. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'You can associate only a limited number of ApsaraDB RDS instances with a scaling group. Go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the maximum number of ApsaraDB RDS instances that you can associate with a scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["rm-bp142f86de0t7****", "rm-bp18l1z42ar4o****", "rm-bp1lqr97h4aqk****"]', + ], + ], + [ + 'name' => 'RemovalPolicy.1', + 'in' => 'query', + 'schema' => [ + 'description' => 'The first instance removal policy. You cannot set the **RemovalPolicy.1** parameter, the **RemovalPolicy.2** parameter, and the **RemovalPolicy.3** parameter to the same value.'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + .'* CustomPolicy: removes ECS instances based on the custom scale-in policy (Function).'."\n" + ."\n" + .'The scaling configuration source specified by the **OldestScalingConfiguration **setting can be a scaling configuration or a launch template. You can specify **CustomPolicy **only as the value of the **RemovalPolicy.1** parameter. If you set the **RemovalPolicy.1** parameter to **CustomPolicy**, you must also specify the **CustomPolicyARN **parameter.'."\n" + ."\n" + .'> The removal of ECS instances from a scaling group is also affected by the value of the **MultiAZPolicy** parameter. For more information, see the [Configure a combination policy for removing instances](~~254822~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OldestScalingConfiguration', + ], + ], + [ + 'name' => 'RemovalPolicy.2', + 'in' => 'query', + 'schema' => [ + 'description' => 'The second instance removal policy. You cannot set the **RemovalPolicy.1 **parameter, the **RemovalPolicy.2** parameter, and the **RemovalPolicy.3** parameter to the same value. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + ."\n" + .'> The removal of ECS instances from a scaling group is also affected by the value of the **MultiAZPolicy **parameter. For more information, see the [Configure a combination policy for removing instances](~~254822~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OldestInstance', + ], + ], + [ + 'name' => 'RemovalPolicy.3', + 'in' => 'query', + 'schema' => [ + 'description' => 'The third instance removal policy. You cannot set the **RemovalPolicy.1** parameter, the **RemovalPolicy.2** parameter, and the **RemovalPolicy.3** parameter to the same value. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + ."\n" + .'> The removal of ECS instances from a scaling group is also affected by the value of the **MultiAZPolicy **parameter. For more information, see the [Configure a combination policy for removing instances](~~254822~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NewestInstance', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch. If you specify the **VSwitchId **parameter, the network type of the scaling group is VPC.'."\n" + ."\n" + .'> If you do not specify the **VSwitchId **or **VSwitchIds.N** parameter, the network type of the scaling group is classic network.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp14zolna43z266bq****', + ], + ], + [ + 'name' => 'MultiAZPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scaling policy for the multi-zone scaling group that contains ECS instances. Valid values:'."\n" + ."\n" + .'* PRIORITY: Auto Scaling scales ECS instances based on the priority of the vSwitch that is specified by the **VSwitchIds.N** parameter. Auto Scaling preferentially scales instances in the zone where the vSwitch that has the highest priority resides. If the scaling fails, Auto Scaling scales instances in the zone where the vSwitch that has the next highest priority resides.'."\n" + ."\n" + .'* COST_OPTIMIZED: Auto Scaling preferentially creates ECS instances whose vCPUs are provided at the lowest price and removes ECS instances whose vCPUs are provided at the highest price. If preemptible instance types are specified in the scaling configuration, Auto Scaling preferentially creates preemptible instances. You can use the **CompensateWithOnDemand **parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** The **COST_OPTIMIZED **setting takes effect only when you specify multiple instance types or when you specify at least one preemptible instance type.'."\n" + ."\n" + .'* BALANCE: Auto Scaling evenly distributes ECS instances across zones that are specified for the scaling group. If ECS instances are unevenly distributed across zones due to insufficient resources, you can call the [RebalanceInstance](~~71516~~) operation to evenly distribute the instances across the zones.'."\n" + ."\n" + .'* COMPOSABLE: You can combine the preceding policies based on your business requirements.'."\n" + ."\n" + .'Default value: PRIORITY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRIORITY', + ], + ], + [ + 'name' => 'HealthCheckType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The health check mode of the scaling group. Valid values:'."\n" + ."\n" + .'* NONE: Auto Scaling does not perform health checks on instances in the scaling group.'."\n" + .'* ECS: Auto Scaling performs health checks on ECS instances in the scaling group.'."\n" + ."\n" + .'Default value: ECS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'ScalingPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The reclaim mode of the scaling group. Valid values:'."\n" + ."\n" + .'* recycle: economical mode'."\n" + .'* release: release mode'."\n" + ."\n" + .'**ScalingPolicy **specifies the reclaim mode of scaling groups. The policy that is used to remove ECS instances from scaling groups is specified by the **RemovePolicy **parameter of the **RemoveInstances **operation. For more information, see the [RemoveInstances](~~25955~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'recycle', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'OnDemandBaseCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of pay-as-you-go instances that must be contained in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter to `COMPOSABLE` Policy, the default value of this parameter is 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'OnDemandPercentageAboveBaseCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances reaches the requirement. Valid values: 0 to 100.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter to `COMPOSABLE` Policy, the default value of this parameter is 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SpotInstanceRemedy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to supplement preemptible instances. If you set this parameter to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives a system message which indicates that the preemptible instance is to be reclaimed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CompensateWithOnDemand', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically create pay-as-you-go instances to meet the requirement on the number of ECS instances when the expected capacity of preemptible instances cannot be provided due to reasons such as cost-related issues and insufficient resources. This parameter is available only if you set the `MultiAZPolicy` parameter to `COST_OPTIMIZED`. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SpotInstancePools', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instance types that you want to specify. Auto Scaling evenly creates preemptible instances of multiple instance types that are provided at the lowest price in the scaling group. Valid values: 1 to 10.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter to `COMPOSABLE`, the default value of this parameter is 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances. The expected number cannot be greater than the value of the **MaxSize **parameter and cannot be less than the value of the **MinSize **parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'GroupDeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable deletion protection for the scaling group. Valid values:'."\n" + ."\n" + .'* true: enables deletion protection for the scaling group. This way, the scaling group cannot be deleted.'."\n" + .'* false: disables deletion protection for the scaling group.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instances that are managed by the scaling group. Valid values:'."\n" + ."\n" + .'* ECS: ECS instances'."\n" + .'* ECI: elastic container instances'."\n" + ."\n" + .'Default value: ECS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'ContainerGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the elastic container instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eci-uf6fonnghi50u374****', + ], + ], + [ + 'name' => 'VSwitchIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of vSwitches. If you specify the **VSwitchIds.N** parameter, the **VSwitchId **parameter is ignored. If you specify the **VSwitchIds.N** parameter, the network type of the scaling group is VPC.'."\n" + ."\n" + .'If you specify multiple vSwitches, take note of the following items:'."\n" + ."\n" + .'* The vSwitches must belong to the same VPC.'."\n" + .'* The vSwitches can belong to different zones.'."\n" + .'* The vSwitches are sorted in ascending order of priority. The first vSwitch that is specified by the **VSwitchIds.N** parameter has the highest priority. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.'."\n" + ."\n" + .'> If you do not specify the **VSwitchId **or **VSwitchIds.N** parameter, the network type of the scaling group is classic network.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of vSwitches. If you specify the **VSwitchIds.N** parameter, the **VSwitchId **parameter is ignored. If you specify the **VSwitchIds.N** parameter, the network type of the scaling group is VPC.'."\n" + ."\n" + .'If you specify multiple vSwitches, take note of the following items:'."\n" + ."\n" + .'* The vSwitches must belong to the same VPC.'."\n" + .'* The vSwitches can belong to different zones.'."\n" + .'* The vSwitches are sorted in ascending order of priority. The first vSwitch that is specified by the **VSwitchIds.N** parameter has the highest priority. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.'."\n" + ."\n" + .'> If you do not specify the **VSwitchId **or **VSwitchIds.N** parameter, the network type of the scaling group is classic network.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp14zolna43z266bq****', + ], + 'required' => false, + 'example' => 'vsw-bp14zolna43z266bq****', + 'maxItems' => 8, + ], + ], + [ + 'name' => 'LifecycleHook', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The lifecycle hooks.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DefaultResult' => [ + 'description' => 'The action that Auto Scaling performs after the lifecycle hook of the scaling group times out. Valid values:'."\n" + ."\n" + .'* CONTINUE: continues to respond to scaling requests.'."\n" + .'* ABANDON: releases ECS instances that are created during scale-outs, or removes ECS instances from the scaling group during scale-ins.'."\n" + ."\n" + .'If multiple lifecycle hooks in the scaling group are triggered during a scale-in and you set the **LifecycleHook.N.DefaultResult** parameter to **ABANDON** for one of the lifecycle hooks, Auto Scaling immediately performs the action after the lifecycle hook whose **LifecycleHook.N.DefaultResult** parameter is set to **ABANDON** times out. In this case, other lifecycle hooks time out ahead of schedule. In other cases, Auto Scaling performs the action only after all lifecycle hooks time out. The action that Auto Scaling performs is determined by the value of the **LifecycleHook.N.DefaultResult** parameter that you set for the lifecycle hook that last times out.'."\n" + ."\n" + .'Default value: CONTINUE.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTINUE', + ], + 'LifecycleHookName' => [ + 'description' => 'The name of the lifecycle hook. After you specify this parameter, you cannot change the name of the lifecycle hook. If you do not specify this parameter, the name of the lifecycle hook is the same as the ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lifecyclehook****', + ], + 'LifecycleTransition' => [ + 'description' => 'The type of the scaling activities to which you want to apply the lifecycle hook. Valid values:'."\n" + ."\n" + .'* SCALE_OUT: scale-outs'."\n" + .'* SCALE_IN: scale-ins'."\n" + ."\n" + .'> If you specify lifecycle hooks for the scaling group, the **LifecycleHook.N.LifecycleTransition** parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SCALE_OUT', + ], + 'NotificationMetadata' => [ + 'description' => 'The fixed string that you want to include in a notification. When a lifecycle hook takes effect, Auto Scaling sends a notification. The value of this parameter cannot exceed 128 characters in length. Auto Scaling sends the value of the **NotificationMetadata** parameter together with the notification. This helps you categorize your notifications. If you specify the **NotificationMetadata** parameter, you must also specify the **NotificationArn** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + 'NotificationArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notification method that Auto Scaling uses to send a notification when a lifecycle hook takes effect. This notification method can be a Message Service (MNS) queue or an MNS topic. Specify the value of this parameter in the following format: acs:ess:{region}:{account-id}:{resource-relative-id}.'."\n" + ."\n" + .'* region: the region where the scaling group resides'."\n" + .'* account-id: the ID of the Alibaba Cloud account'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* MNS queue: acs:ess:{region}:{account-id}:queue/{queuename}'."\n" + .'* MNS topic: acs:ess:{region}:{account-id}:topic/{topicname}'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ess:cn-hangzhou:1111111111:queue/queue2', + ], + 'HeartbeatTimeout' => [ + 'description' => 'The period of time before the lifecycle hook times out. After the lifecycle hook times out, Auto Scaling performs the action specified by the **DefaultResult** parameter. Valid values: 30 to 21600. Unit: seconds.'."\n" + ."\n" + .'After you create a lifecycle hook, you can call the [RecordLifecycleActionHeartbeat](~~73846~~) operation to prolong the timeout period of the lifecycle hook. You can also call the [CompleteLifecycleAction](~~73847~~) operation to end the timeout period ahead of schedule.'."\n" + ."\n" + .'Default value: 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'VServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the backend vServer groups that you want to associate with the scaling group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VServerGroupAttribute' => [ + 'description' => 'VServerGroupAttribute', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => [ + 'description' => 'The ID of the backend vServer group.'."\n" + ."\n" + .'For more information, see the [AttachVServerGroups](~~98983~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rsp-bp1443g77****', + ], + 'Weight' => [ + 'description' => 'The weight of an ECS instance after Auto Scaling adds the ECS instance to the backend vServer group as a backend server. If you increase the weight of an ECS instance in a backend vServer group, the number of access requests that are forwarded to the ECS instance increases. If you set the **Weight **parameter of an ECS instance in a backend vServer group to **0**, no access requests are forwarded to the ECS instance. Valid values: 0 to 100. Default value: 50.'."\n" + ."\n" + .'For more information, see the [AttachVServerGroups](~~98983~~) topic.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number that is used by an ECS instance after Auto Scaling adds the ECS instance to the backend vServer group. Valid values: 1 to 65535.'."\n" + ."\n" + .'For more information, see the [AttachVServerGroups](~~98983~~) topic.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'LoadBalancerId' => [ + 'description' => 'The ID of the CLB instance to which the backend vServer group belongs.'."\n" + ."\n" + .'For more information, see the [AttachVServerGroups](~~98983~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-bp1u7etiogg38yvwz****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the tags that you want to add to the scaling group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N that you want to add to the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Department', + ], + 'Value' => [ + 'description' => 'The value of tag N that you want to add to the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Finance', + ], + 'Propagate' => [ + 'description' => 'Specifies whether to propagate tag N that you want to add to the scaling group. Valid values:'."\n" + ."\n" + .'* true: propagates tag N to instances that are newly created and does not propagate tag N to instances that are already running in the scaling group.'."\n" + .'* false: does not propagate tag N to any instances.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'LaunchTemplateOverride', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the instance types that you specify by using the Extended Configurations feature of the launch template.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'Instance type N that you want to use to override the instance type that is specified in the launch template. If you want to scale instances in the scaling group based on the weighted capacity of the instances, you must specify the **LaunchTemplateOverride.N.InstanceType** and **LaunchTemplateOverride.N.WeightedCapacity** parameters.'."\n" + ."\n" + .'You can specify N instance types by using the Extended Configurations feature of the launch template. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> This parameter is available only if you specify the **LaunchTemplateId **parameter.'."\n" + ."\n" + .'For information about the valid values of **InstanceType **in **InstanceTypeOverride.N.InstanceType**, see the [Overview of instance families](~~25378~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c5.xlarge', + ], + 'WeightedCapacity' => [ + 'description' => 'The weight of instance type N. The weight of an instance type specifies the capacity of an instance of the instance type in the scaling group. If you want to scale instances in the scaling group based on the weighted capacity of the instances, you must specify the **LaunchTemplateOverride.N.WeightedCapacity** parameter after you specify the **LaunchTemplateOverride.N.InstanceType** parameter. The values of N in the two parameters must be the same.'."\n" + ."\n" + .'A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.'."\n" + ."\n" + .'Performance metrics, such as the number of vCPUs and the memory size of each instance type, may vary. You can specify different weights for different instance types based on your business requirements.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'* Current capacity: 0'."\n" + .'* Expected capacity: 6'."\n" + .'* Capacity of ecs.c5.xlarge: 4'."\n" + ."\n" + .'To meet the expected capacity requirement, Auto Scaling must create two ecs.c5.xlarge instances.'."\n" + ."\n" + .'> The capacity of the scaling group during a scale-out cannot exceed the sum of the maximum number of instances that is specified by the **MaxSize **parameter and the maximum weight of the instance types.'."\n" + ."\n" + .'Valid values of **WeightedCapacity **in the **InstanceTypeOverride.N.WeightedCapacity** parameter: 1 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum bid price of instance type N that is specified by the `LaunchTemplateOverride.N.InstanceType` parameter. You can specify N instance types by using the Extended Configurations feature of the launch template. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> This parameter is available only if you specify the `LaunchTemplateId` parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.025', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AlbServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the Application Load Balancer (ALB) server groups that you want to associate with the scaling group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AlbServerGroupId' => [ + 'description' => 'The ID of ALB server group N.'."\n" + ."\n" + .'N specifies the serial number of the ALB server group. You can associate only a limited number of ALB server groups with a scaling group. Go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the maximum number of ALB server groups that you can associate with a scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sgp-ddwb0y0g6y9bjm****', + ], + 'Weight' => [ + 'description' => 'The weight of an ECS instance after Auto Scaling adds the ECS instance to ALB server group N as a backend server. If you increase the weight of an ECS instance in ALB server group N, the number of access requests that are forwarded to the ECS instance also increases. If you set the **Weight **parameter of an ECS instance in ALB server group N to **0**, no access requests are forwarded to the ECS instance. Valid values: 0 to 100.'."\n" + ."\n" + .'N specifies the serial number of the ALB server group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number that is used by an ECS instance after Auto Scaling adds the ECS instance to ALB server group N. Valid values: 1 to 65535.'."\n" + ."\n" + .'N specifies the serial number of the ALB server group.'."\n" + ."\n" + .'> If the N values are the same but the port numbers are different, Auto Scaling associates multiple ports of ALB server group N with the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the server groups.'."\n" + ."\n" + .'>You cannot use the AlbServerGroups parameter and the ServerGroups parameter to specify the same server group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServerGroupId' => [ + 'description' => 'The ID of server group N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sgp-5yc3bd9lfyh*****', + ], + 'Type' => [ + 'description' => 'The type of server group N. Valid values:'."\n" + ."\n" + .'* ALB'."\n" + .'* NLB'."\n" + ."\n" + .'> Auto Scaling supports the following types of server groups: ALB server groups and NLB server groups.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALB', + ], + 'Weight' => [ + 'description' => 'The weight of an ECS instance after Auto Scaling adds the ECS instance to server group N as a backend server. Valid values: 0 to 100.'."\n" + ."\n" + .'If you increase the weight of an ECS instance in server group N, the number of access requests that are forwarded to the ECS instance also increases. If you set the **Weight **parameter of an ECS instance in server group N to **0**, no access requests are forwarded to the ECS instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number that is used by an ECS instance in the scaling group after Auto Scaling adds the ECS instance to server group N. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AzBalance', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to evenly distribute instances in the scaling group across multiple zones. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AllocationStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create the required number of instances. The policy can be applied to pay-as-you-go instances and preemptible instances. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* priority: Auto Scaling selects instance types based on the specified orders of the instance types to create the required number of instances.'."\n" + .'* lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of instances.'."\n" + ."\n" + .'Default value: priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'priority', + ], + ], + [ + 'name' => 'SpotAllocationStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The allocation policy of preemptible instances. You can use this parameter to individually specify the allocation policy of preemptible instances. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* priority: Auto Scaling selects instance types based on the specified orders of the instance types to create the required number of preemptible instances.'."\n" + .'* lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of preemptible instances.'."\n" + ."\n" + .'Default value: priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lowestPrice', + ], + ], + [ + 'name' => 'MaxInstanceLifetime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum life span of an instance in the scaling group. Unit: seconds.'."\n" + ."\n" + .'Valid values: 86400 to the value of the `Integer.maxValue` parameter.'."\n" + ."\n" + .'Default value: null.'."\n" + ."\n" + .'> You cannot specify this parameter for scaling groups that manage elastic container instances or scaling groups whose ScalingPolicy parameter is set to recycle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'CustomPolicyARN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function). This parameter is available only if you specify **CustomPolicy **as the value of the **RemovalPolicy.1** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which you want to add the scaling group.'."\n" + ."\n" + .'> If you specify this parameter, new scaling groups are added to the specified resource group. If you do not specify this parameter, new scaling groups are added to the default resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-123****', + ], + ], + [ + 'name' => 'LoadBalancerConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoadBalancerId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The ID of the SLB instance.'."\n", + 'example' => 'lb-2zefi4w0emxh131bg3l9b', + ], + 'Weight' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'description' => 'Auto Scaling adds an ECS instance to a Server Load Balancer CLB server group, and the ECS instance is used as the weight of the backend server. The higher the weight, the more access requests the ECS instance will be assigned. If the weight is 0, the ECS instance does not receive access requests.'."\n" + ."\n" + .'Value range: 0~100.', + 'example' => '10', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'description' => 'LoadBalancerConfig', + ], + ], + [ + 'name' => 'HealthCheckTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'DBInstance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + 'AttachMode' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 5, + ], + ], + [ + 'name' => 'StopInstanceTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'CapacityOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OnDemandBaseCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'OnDemandPercentageAboveBaseCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CompensateWithOnDemand' => [ + 'type' => 'boolean', + ], + 'SpotAutoReplaceOnDemand' => [ + 'type' => 'boolean', + ], + 'PriceComparisonMode' => [ + 'type' => 'string', + ], + ], + ], + ], + [ + 'name' => 'BalanceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '负载均衡模式', + 'type' => 'string', + ], + ], + [ + 'name' => 'AutoRebalance', + 'in' => 'query', + 'schema' => [ + 'title' => '自动重新平衡设置', + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ResourceNotAvailable.VPCNetwork', + 'errorMessage' => 'The specified zone does not support vpc network or sold out.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ScalingGroupId\\": \\"asg-bp14wlu85wrpchm0****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScalingGroupResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ScalingGroupId>asg-bp14wlu85wrpchm0****</ScalingGroupId>\\n</CreateScalingGroupResponse>","errorExample":""}]', + 'title' => 'CreateScalingGroup', + 'description' => '## Description'."\n" + ."\n" + .'A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.'."\n" + ."\n" + .'You can create only a limited number of scaling groups in a region. Go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check your quota of scaling groups.****'."\n" + ."\n" + .'A scaling group does not immediately take effect after you create the scaling group. You must call the [EnableScalingGroup](~~25939~~) operation to enable the scaling group. After you enable the scaling group, Auto Scaling can execute scaling rules to trigger scaling activities in the scaling group.'."\n" + ."\n" + .'The Classic Load Balancer (CLB) instances and ApsaraDB RDS instances that you want to associate with a scaling group must reside in the same region as the scaling group. CLB instances are formerly known as Server Load Balancer (SLB) instances. For more information, see the [Regions and zones](~~40654~~) topic.'."\n" + ."\n" + .'If you associate a CLB instance with a scaling group, Auto Scaling automatically adds ECS instances in the scaling group to the backend server groups of the associated CLB instance. You can specify a server group to which ECS instances can be added. You can add ECS instances to the following types of server groups:'."\n" + ."\n" + .'* Default server group: a group of ECS instances that are used to receive requests. If you do not specify a vServer group or a primary/secondary server group for a listener, requests are forwarded to the ECS instances in the default server group.'."\n" + ."\n" + .'* vServer group: If you want to forward requests to backend servers that are not in the default server group or configure domain name-based or URL-based forwarding rules, you can use vServer groups.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all the specified server groups.'."\n" + ."\n" + .' The default weight of an ECS instance that is added as a backend server of a CLB instance is 50. The CLB instance that you want to associate with your scaling group must meet the following requirements:'."\n" + ."\n" + .'* The CLB instance must be in the **Active **state. You can call the [DescribeLoadBalancers](~~27582~~) operation to query the status of the CLB instance.'."\n" + ."\n" + .'* The health check feature must be enabled on all listener ports that are configured for the CLB instance. Otherwise, the scaling group cannot be created.'."\n" + ."\n" + .'If you associated an Application Load Balancer (ALB) or Network Load Balancer (NLB) server group with a scaling group, Auto Scaling automatically adds ECS instances in the scaling group to the ALB or NLB server group to process requests distributed by the ALB or NLB instance to which the associated server group belongs. You can specify multiple ALB or NLB server groups, but the server groups must belong to the same virtual private cloud (VPC) as the scaling group. For more information, see [AttachAlbServerGroups](~~266800~~) or [AttachServerGroups](~~600535~~).'."\n" + ."\n" + .'If you associated an ApsaraDB RDS instance with a scaling group, Auto Scaling automatically adds the private IP addresses of the ECS instances that are in the scaling group to the IP address whitelist of the ApsaraDB RDS instance. The ApsaraDB RDS instance that you want to associate with your scaling group must meet the following requirements:'."\n" + ."\n" + .'* The ApsaraDB RDS instance must be in the **Running **state. You can call the [DescribeDBInstances](~~26232~~) operation to query the status of the ApsaraDB RDS instance.'."\n" + .'* The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance cannot exceed the upper limit. For more information, see the [Configure IP address whitelists](~~43185~~) topic.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter of the scaling group to `COST_OPTIMIZED`, take note of the following items:'."\n" + ."\n" + .'* You can use the **OnDemandBaseCapacity**, **OnDemandPercentageAboveBaseCapacity**, and **SpotInstancePools **parameters to specify an instance allocation method based on the cost optimization policy. The specified instance allocation method is prioritized during scaling.'."\n" + .'* If you do not specify the **OnDemandBaseCapacity**, **OnDemandPercentageAboveBaseCapacity**, or **SpotInstancePools **parameter, the instance types that are provided at the lowest price are used to create instances based on the cost optimization policy.'."\n" + ."\n" + .'If you set the `Tag.N.Propagate` parameter of the scaling group to `true`, take note of the following items:'."\n" + ."\n" + .'* Tags that you add to the scaling group cannot be propagated to existing instances in the scaling group. Tags that you add to the scaling group are propagated to only new instances.'."\n" + .'* If you specify instance tags in the scaling configuration that is used to create instances and propagate the tags that you add to the scaling group to the instances, all tags exist at the same time.'."\n" + .'* If the tag key that you specify in a scaling configuration and the tag key that you add to the scaling group of the scaling configuration are the same, the tag value that you specify in the scaling configuration is preferentially used.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteScalingGroup' => [ + 'summary' => 'Deletes a scaling group. ', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92667', + 'abilityTreeNodes' => [ + 'FEATUREess909XOL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ForceDelete', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to forcibly delete the scaling group and remove and release Elastic Compute Service (ECS) instances in the scaling group when the ECS instances or ongoing scaling activities exist in the scaling group. Valid values:'."\n" + ."\n" + .'* true: The scaling group is disabled and new scaling requests are rejected. After all existing scaling requests are processed, the ECS instances in the scaling group are removed. Then, the scaling group is deleted. If the ECS instances are manually added to the scaling group, the ECS instances are removed. If the ECS instances are automatically created in the scaling group, the ECS instances are removed and released.'."\n" + ."\n" + .'* false: You can set this parameter to false if the following conditions are met:'."\n" + ."\n" + .' * No ongoing scaling activities exist in the scaling group.'."\n" + .' * The Total Capacity parameter is set to 0, which specifies that no ECS instances exist in the scaling group.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScalingGroupResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DeleteScalingGroupResponse>","errorExample":""}]', + 'title' => 'DeleteScalingGroup', + 'description' => '## Description'."\n" + ."\n" + .'Before you call the DeleteScalingGroup operation to delete a scaling group, take note of the following items:'."\n" + ."\n" + .'* If you delete a scaling group, the scaling configuration, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.'."\n" + .'* If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances with which the scaling group is associated are also not deleted.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyScalingGroup' => [ + 'summary' => 'Modifies a scaling group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92709', + 'abilityTreeNodes' => [ + 'FEATUREessXN6KX4', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group that you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp1ffogfdauy0jw0****', + ], + ], + [ + 'name' => 'ScalingGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling group. The name of each scaling group must be unique in a region. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'MinSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of ECS instances in the scaling group. When the number of ECS instances in the scaling group is less than the value of the MinSize parameter, Auto Scaling automatically adds ECS instances until the number of instances is equal to the value of the `MinSize` parameter.'."\n" + ."\n" + .'> The value of the `MinSize` parameter must be less than or equal to the value of the `MaxSize` parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of ECS instances in the scaling group. When the number of ECS instances in the scaling group is greater than the value of the MaxSize parameter, Auto Scaling automatically removes ECS instances from the scaling group until the number of instances is equal to the value of the `MaxSize` parameter.'."\n" + ."\n" + .'The value range of the MaxSize parameter varies based on the instance quota. You can go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the quota of instances that can be added to a scaling group.****'."\n" + ."\n" + .'For example, if the quota of instances that can be added to a scaling group is 2,000, the valid values of the `MaxSize` parameter range from 0 to 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '99', + ], + ], + [ + 'name' => 'DefaultCooldown', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cooldown time of the scaling group after a scaling activity is triggered. Valid values: 0 to 86400. Unit: seconds.'."\n" + ."\n" + .'During the cooldown time, Auto Scaling executes only scaling activities that are triggered by event-triggered tasks monitored by CloudMonitor.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '86400', + 'minimum' => '0', + 'example' => '600', + ], + ], + [ + 'name' => 'RemovalPolicy.1', + 'in' => 'query', + 'schema' => [ + 'description' => 'The first step to remove ECS instances from the scaling group. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + .'* CustomPolicy: removes ECS instances based on the custom scale-in policy (Function).'."\n" + ."\n" + .'> The scaling configuration source specified by OldestScalingConfiguration can be a scaling configuration or a launch template. The CustomPolicy setting is available only for the RemovalPolicy.1 parameter. If you set the RemovalPolicy.1 parameter to CustomPolicy, you must also specify the CustomPolicyARN parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OldestScalingConfiguration', + ], + ], + [ + 'name' => 'RemovalPolicy.2', + 'in' => 'query', + 'schema' => [ + 'description' => 'The second step to remove ECS instances from the scaling group. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + ."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + ."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** The scaling configuration source specified by OldestScalingConfiguration can be a scaling configuration or a launch template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NewestInstance', + ], + ], + [ + 'name' => 'RemovalPolicy.3', + 'in' => 'query', + 'schema' => [ + 'description' => 'The third step to remove ECS instances from the scaling group. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + ."\n" + .'> The scaling configuration source specified by OldestScalingConfiguration can be a scaling configuration or a launch template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OldestInstance', + ], + ], + [ + 'name' => 'ActiveScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the active scaling configuration in the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc-bp17pelvl720x5ub****', + ], + ], + [ + 'name' => 'HealthCheckType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The health check mode of the scaling group. Valid values:'."\n" + ."\n" + .'* NONE: Auto Scaling does not perform health checks on instances in the scaling group.'."\n" + .'* ECS: Auto Scaling performs health checks on ECS instances in the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'LaunchTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the launch template that is used by Auto Scaling to create instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lt-m5e3ofjr1zn1aw7****', + ], + ], + [ + 'name' => 'LaunchTemplateVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the launch template. Valid values:'."\n" + ."\n" + .'* A fixed template version number.'."\n" + .'* Default: the default template version.'."\n" + .'* Latest: the latest template version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'OnDemandBaseCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances.'."\n" + ."\n" + .'If the `MultiAZPolicy` parameter is set to `COMPOSABLE` Policy, the default value is 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'OnDemandPercentageAboveBaseCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The percentage of pay-as-you-go instances among the excess instances when the requirement on the minimum number of pay-as-you-go instances is met. Valid values: 0 to 100.'."\n" + ."\n" + .'If the `MultiAZPolicy` parameter is set to `COMPOSABLE` Policy, the default value is 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SpotInstanceRemedy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to supplement preemptible instances. If you set this parameter to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives a system message that indicates the preemptible instance is to be reclaimed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CompensateWithOnDemand', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically create pay-as-you-go instances to meet the requirement on the number of ECS instances in the scaling group when the number of preemptible instances cannot be reached due to reasons such as costs and insufficient resources. This parameter takes effect only if you set the MultiAZPolicy parameter in the CreateScalingGroup operation to COST_OPTIMIZED. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SpotInstancePools', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instance types that you specify. Auto Scaling creates preemptible instances of multiple instance types that are provided at the lowest price. Valid values: 0 to 10.'."\n" + ."\n" + .'If the `MultiAZPolicy` parameter is set to `COMPOSABLE` Policy, the default value is 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances that you specify. The expected number cannot be greater than the value of the MaxSize parameter and cannot be less than the value of the MinSize parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'GroupDeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable deletion protection for the scaling group. Valid values:'."\n" + ."\n" + .'* true: enables deletion protection for the scaling group. This way, the scaling group cannot be deleted.'."\n" + .'* false: disables deletion protection for the scaling group.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MultiAZPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scaling policy for the multi-zone scaling group that contains ECS instances. Valid values:'."\n" + ."\n" + .'* PRIORITY: The first vSwitch specified by using the VSwitchIds.N parameter has the highest priority. Auto Scaling scales instances in the zone where the vSwitch that has the highest priority resides. If the scaling fails, Auto Scaling scales instances in the zone where the vSwitch that has the next highest priority resides.'."\n" + ."\n" + .'* COST_OPTIMIZED: Auto Scaling creates ECS instances whose vCPUs are provided at the lowest price during scale-out activities and removes ECS instances whose vCPUs are provided at the highest price during scale-in activities. If preemptible instance types are specified in the active scaling configuration, Auto Scaling preferentially creates preemptible instances. You can use the `CompensateWithOnDemand` parameter to specify whether to automatically create pay-as-you-go instances when Auto Scaling fails to create preemptible instances.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** The COST_OPTIMIZED setting takes effect only when you specify multiple instance types or when you specify at least one preemptible instance type.'."\n" + ."\n" + .'* BALANCE: Auto Scaling evenly distributes ECS instances across zones that are specified for the scaling group. If ECS instances are unevenly distributed across zones due to insufficient resources, you can call the [RebalanceInstance](~~71516~~) operation to evenly distribute the instances across the zones.'."\n" + ."\n" + .'* COMPOSABLE: You can flexibly combine the preceding policies based on your business requirements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRIORITY', + ], + ], + [ + 'name' => 'VSwitchIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of vSwitches.'."\n" + ."\n" + .'This parameter takes effect only when the network type of the scaling group is VPC. The specified vSwitches and the scaling group must reside in the same VPC.'."\n" + ."\n" + .'The vSwitches can reside in different zones. The vSwitches are sorted in ascending order. The first vSwitch specified by using the VSwitchIds parameter has the highest priority. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of vSwitch N. Valid values of N: 1 to 5.'."\n" + ."\n" + .'This parameter is available only if the network type of the scaling group is virtual private cloud (VPC). The specified vSwitches and the scaling group must reside in the same VPC.'."\n" + ."\n" + .'The vSwitches can reside in different zones. The vSwitches are sorted in ascending order based on the value of N. 1 specifies the highest priority. A greater value of N specifies a lower priority. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1oo2a7isyrb8igf****', + ], + 'required' => false, + 'example' => 'vsw-bp1oo2a7isyrb8igf****', + 'maxItems' => 8, + ], + ], + [ + 'name' => 'LaunchTemplateOverride', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the instance types that are specified in the extended configurations of the launch template.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'Instance type N. The instance type that is specified by using this parameter overrides the instance type that is specified in the launch template. If you want to scale instances in the scaling group based on the weighted capacity of instances, you must specify the LaunchTemplateOverride.N.InstanceType and LaunchTemplateOverride.N.WeightedCapacity parameters at the same time.'."\n" + ."\n" + .'You can specify N instance types by using the Extended Configurations feature of the launch template. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> This parameter is available only if you specify the LaunchTemplateId parameter.'."\n" + ."\n" + .'For information about the valid values of InstanceType in InstanceTypeOverride.N.InstanceType, see [Overview of instance families](~~25378~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c5.xlarge', + ], + 'WeightedCapacity' => [ + 'description' => 'The weight of instance type N. The weight of an instance type specifies the capacity of a single instance of the instance type in the scaling group. If you want to scale instances in the scaling group based on the weighted capacity of instances, you must specify the LaunchTemplateOverride.N.WeightedCapacity parameter after you specify the LaunchTemplateOverride.N.InstanceType parameter. The values of N in the two parameters must be the same.'."\n" + ."\n" + .'A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.'."\n" + ."\n" + .'Performance metrics, such as the number of vCPUs and the memory size of each instance type, may vary. You can specify different weights for different instance types based on your business requirements.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'* Current capacity: 0'."\n" + .'* Expected capacity: 6'."\n" + .'* Capacity of ecs.c5.xlarge: 4'."\n" + ."\n" + .'To meet the expected capacity requirement, Auto Scaling must create two ecs.c5.xlarge instances.'."\n" + ."\n" + .'> The capacity of the scaling group cannot exceed the sum of the maximum number of instances that is specified by the MaxSize parameter and the maximum weight of the instance type.'."\n" + ."\n" + .'Valid values of WeightedCapacity in the InstanceTypeOverride.N.WeightedCapacity parameter: 1 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum bid price of instance type N that is specified by the `LaunchTemplateOverride.N.InstanceType` parameter. You can specify N instance types by using the Extended Configurations feature of the launch template. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> This parameter is available only if you specify the `LaunchTemplateId` parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.025', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AzBalance', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to evenly distribute instances in the scaling group across multiple zones. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AllocationStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create instances. The policy can be applied to pay-as-you-go instances and preemptible instances. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* priority: Auto Scaling selects instance types based on the specified orders of the instance types to create instances.'."\n" + .'* lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPU to create instances.'."\n" + ."\n" + .'Default value: priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'priority', + ], + ], + [ + 'name' => 'SpotAllocationStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The allocation policy of preemptible instances. You can use this parameter to individually specify the allocation policy of preemptible instances. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* priority: Auto Scaling selects instance types based on the specified orders of the instance types to create preemptible instances.'."\n" + .'* lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPU to create preemptible instances.'."\n" + ."\n" + .'Default value: priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lowestPrice', + ], + ], + [ + 'name' => 'MaxInstanceLifetime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum life span of the instance in the scaling group. Unit: seconds.'."\n" + ."\n" + .'Valid values: 86400 to `Integer.maxValue`. You can also set this parameter to 0. If you set this parameter to 0, the instance has an unlimited life span.'."\n" + ."\n" + .'Default value: null.'."\n" + ."\n" + .'> You cannot specify this parameter for scaling groups that contain elastic container instances or scaling groups whose ScalingPolicy is set to recycle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'CustomPolicyARN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function). This parameter is available only if you specify CustomPolicy as the first step of the instance removal policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name', + ], + ], + [ + 'name' => 'DisableDesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ScalingPolicy', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HealthCheckTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StopInstanceTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'CapacityOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OnDemandBaseCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'OnDemandPercentageAboveBaseCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CompensateWithOnDemand' => [ + 'type' => 'boolean', + ], + 'SpotAutoReplaceOnDemand' => [ + 'type' => 'boolean', + ], + 'PriceComparisonMode' => [ + 'type' => 'string', + ], + ], + ], + ], + [ + 'name' => 'BalanceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '负载均衡模式', + 'type' => 'string', + ], + ], + [ + 'name' => 'AutoRebalance', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyScalingGroupResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyScalingGroupResponse>","errorExample":""}]', + 'title' => 'ModifyScalingGroup', + 'description' => '## Description'."\n" + ."\n" + .'* You cannot modify the settings of the following parameters:'."\n" + ."\n" + .' * RegionId'."\n" + ."\n" + .' * LoadBalancerId'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If you want to disassociate your scaling group from a Classic Load Balancer (CLB) instance, you can call the [DetachLoadBalancers](~~85141~~) operation. If you want to associate your scaling group with another CLB instance, you can call the [AttachLoadBalancers](~~85125~~) operation.'."\n" + ."\n" + .' * DBInstanceId'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If you want to disassociate your scaling group from an ApsaraDB RDS instance, you can call the [DetachDBInstances](~~85380~~) operation. If you want to associate your scaling group with another ApsaraDB RDS instance, you can call the [AttachDBInstances](~~85379~~) operation.'."\n" + ."\n" + .'* You can modify a scaling group only when the scaling group is in the Active or Inactive state.'."\n" + ."\n" + .'* If you enable a new scaling configuration, Elastic Compute Service (ECS) instances that are created based on the previous scaling configuration still run as expected in the scaling group.'."\n" + ."\n" + .'* If the total number of instances in the scaling group is greater than the allowed maximum number after you change the value of the MaxSize parameter, Auto Scaling automatically removes excess instances from the scaling group to ensure that the number of instances is within the new range.'."\n" + ."\n" + .'* If the total number of instances in the scaling group is less than the allowed minimum number after you change the value of the MinSize parameter, Auto Scaling automatically adds instances to the scaling group to ensure that the number of instances is within the new range.'."\n" + ."\n" + .'* If the total number of instances in the scaling group does not match the expected number of instances after you change the value of the DesiredCapacity parameter, Auto Scaling automatically adds instances to or removes instances from the scaling group to ensure that the number of instances matches the value of the DesiredCapacity parameter.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'EnableScalingGroup' => [ + 'summary' => '启用一个伸缩组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92696', + 'abilityTreeNodes' => [ + 'FEATUREessUCEVTM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + ], + [ + 'name' => 'ActiveScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling configuration that you need to put into the Active state.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc-bp1ffogfdauy0nu5****', + ], + ], + [ + 'name' => 'LaunchTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the launch template that you want to use to create instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lt-m5e3ofjr1zn1aw7****', + ], + ], + [ + 'name' => 'LaunchTemplateVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the launch template. Valid values:'."\n" + ."\n" + .'* A fixed template version number.'."\n" + .'* Default: the default template version.'."\n" + .'* Latest: the latest template version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of instance N that you want to add to the scaling group after the scaling group is enabled. Valid values of N: 1 to 20.'."\n" + ."\n" + .'Before you add ECS instances to a scaling group, make sure that the instances meet the following requirements:'."\n" + ."\n" + .'* The instances and the scaling group must reside in the same region.'."\n" + .'* The instances are in the Running state.'."\n" + .'* The instances are not in other scaling groups.'."\n" + .'* The instances are billed on a subscription or pay-as-you-go basis, or the instances are preemptible instances.'."\n" + .'* If the VswitchID parameter is specified for the scaling group, the instances must reside in the same virtual private cloud (VPC) as the specified vSwitch. Instances reside in the classic network or other VPCs cannot be added to the scaling group.'."\n" + .'* If the VswitchID parameter is not specified for the scaling group, the ECS instances must not reside in VPCs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of instance N that you want to add to the scaling group after the scaling group is enabled. Valid values of N: 1 to 20.'."\n" + ."\n" + .'Before you add ECS instances to a scaling group, make sure that the instances meet the following requirements:'."\n" + ."\n" + .'* The instances and the scaling group must reside in the same region.'."\n" + .'* The instances are in the Running state.'."\n" + .'* The instances are not in other scaling groups.'."\n" + .'* The instances are billed on a subscription or pay-as-you-go basis, or the instances are preemptible instances.'."\n" + .'* If the VswitchID parameter is specified for the scaling group, the instances must reside in the same virtual private cloud (VPC) as the specified vSwitch. Instances reside in the classic network or other VPCs cannot be added to the scaling group.'."\n" + .'* If the VswitchID parameter is not specified for the scaling group, the ECS instances must not reside in VPCs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-283vv****', + ], + 'required' => false, + 'example' => 'i-283vv****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LoadBalancerWeight', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The weight of instance N that serves as a backend server of the associated Server Load Balancer (SLB) instance. Valid values of N: 1 to 20. Valid values of this parameter: 1 to 100.'."\n" + ."\n" + .'Default value: 50.', + 'type' => 'array', + 'items' => [ + 'description' => 'The weight of instance N that serves as a backend server of the associated Server Load Balancer (SLB) instance. Valid values of N: 1 to 20. Valid values of this parameter: 1 to 100.'."\n" + ."\n" + .'Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'required' => false, + 'example' => '50', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LaunchTemplateOverride', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the instance types that you specify by using the Extended Configurations feature of the launch template.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'If you want to scale instances in the scaling group based on the weighted capacity of instance types, you must specify the LaunchTemplateOverride.N.InstanceType and LaunchTemplateOverride.N.WeightedCapacity parameters at the same time.'."\n" + ."\n" + .'This parameter specifies instance type N that overrides the instance type specified in the launch template. You can specify N instance types in the extended configurations of the launch template. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> This parameter takes effect only when the LaunchTemplateId parameter is specified.'."\n" + ."\n" + .'For information about the valid values of InstanceType in InstanceTypeOverride.N.InstanceType, see [Instance families](~~25378~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c5.xlarge', + ], + 'WeightedCapacity' => [ + 'description' => 'If you want to scale instances in the scaling group based on the weighted capacity of instance types, you must specify the LaunchTemplateOverride.N.WeightedCapacity parameter after you specify the LaunchTemplateOverride.N.InstanceType parameter. The two parameters have a one-to-one correspondence. The value of N in the two parameters must be the same.'."\n" + ."\n" + .'This parameter specifies the weight of the instance type. The weight specifies the capacity of a single instance of the specified instance type in the scaling group. A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity.'."\n" + ."\n" + .'Performance metrics such as the number of vCPUs and the memory size of each instance type may vary. You can specify different weights for different instance types based on your business requirements.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* Current capacity: 0'."\n" + .'* Expected capacity: 6'."\n" + .'* Capacity of ecs.c5.xlarge: 4'."\n" + ."\n" + .'To meet the expected capacity, Auto Scaling creates two ecs.c5.xlarge instances.'."\n" + ."\n" + .'> The capacity of the scaling group cannot exceed the sum of the maximum capacity that is specified by MaxSize and the maximum weight of the instance type.'."\n" + ."\n" + .'Valid values of WeightedCapacity in LaunchTemplateOverride.N.WeightedCapacity: 1 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableScalingGroupResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</EnableScalingGroupResponse>","errorExample":""}]', + 'title' => 'EnableScalingGroup', + 'description' => '## Description'."\n" + ."\n" + .'You can call this operation to enable a scaling group that is in the Inactive state and has an instance configuration source. The instance configuration source can be a scaling configuration, a launch template, or Elastic Compute Service (ECS) instances that you specified when you created the scaling group. If a scaling group is not in the Inactive state or does not have an instance configuration source, you cannot call this operation to enable the scaling group.'."\n" + ."\n" + .'> A scaling group can have only one active instance configuration source at a time. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If an instance configuration source is configured for the scaling group before you call this operation, the scaling configuration or launch template that you specify in the request overwrites the original configuration or template.'."\n" + ."\n" + .'If you specify a value for the InstanceId.N parameter when you call the operation, Auto Scaling checks whether the total number of ECS instances is within the range allowed for the scaling group after you call the operation.'."\n" + ."\n" + .'* If the total number of ECS instances is less than the minimum number of instances allowed in the scaling group after you call the operation, Auto Scaling automatically creates the required number of pay-as-you-go ECS instances to reach the minimum number. For example, if the minimum number of instances allowed in your scaling group is five, and you specify the InstanceId.N parameter to add two created ECS instances to the scaling group, Auto Scaling automatically creates three instances in the scaling group after the two instances are added.'."\n" + .'* If the total number of instances is greater than the maximum number of instances allowed in the scaling group, the operation fails to be called.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DisableScalingGroup' => [ + 'summary' => '停用一个伸缩组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92694', + 'abilityTreeNodes' => [ + 'FEATUREessUCEVTM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableScalingGroupResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DisableScalingGroupResponse>","errorExample":""}]', + 'title' => 'DisableScalingGroup', + 'description' => '## Description'."\n" + ."\n" + .'When you disable a scaling group, take note of the following items:'."\n" + ."\n" + .'* If scaling activities are being executed in the specified scaling group when you call this operation, these activities will continue until they are complete. However, scaling activities that are triggered after this operation is called will be rejected.'."\n" + .'* This operation can be called only when the scaling group is in the Active state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SetGroupDeletionProtection' => [ + 'summary' => '为伸缩组开启或关闭删除保护', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92717', + 'abilityTreeNodes' => [ + 'FEATUREessF87COY', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupDeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable deletion protection for the scaling group. Valid values:'."\n" + ."\n" + .'* true: enables deletion protection. After deletion protection is enabled, you cannot delete the scaling group by using the console or by calling an API operation. Before you delete a scaling group, you must disable deletion protection for the scaling group.'."\n" + .'* false: disables deletion protection.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CCC29E24-3AEC-4F2C-8A14-78B14FA738B7', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CCC29E24-3AEC-4F2C-8A14-78B14FA7****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetGroupDeletionProtectionResponse>\\n <RequestId>CCC29E24-3AEC-4F2C-8A14-78B14FA7****</RequestId>\\n</SetGroupDeletionProtectionResponse>","errorExample":""}]', + 'title' => 'SetGroupDeletionProtection', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=SetGroupDeletionProtection\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'AttachLoadBalancers' => [ + 'summary' => 'Associates one or more Classic Load Balancer (CLB) instances with a scaling group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92650', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp1avr6ensitts3w****', + ], + ], + [ + 'name' => 'ForceAttach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to add all instances in the specified scaling group as backend servers to the SLB instance. Valid values:'."\n" + ."\n" + .'* true: adds all instances.'."\n" + .'* false: does not add all instances.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to guarantee the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use asynchronous calls when you associate an SLB instance with the scaling group. Asynchronous calls ensure the transactional nature of operations, which means that all operations are successfully performed or the execution results do not take effect if some operations fail. We recommend that you use asynchronous calls.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: asynchronous calls. The request returns the ID of the scaling activity.'."\n" + .'* false: synchronous calls.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LoadBalancer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the CLB instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of SLB instance N. Valid values of N: 1 to 5.'."\n", + 'example' => 'lb-2zeur05gfs****', + ], + 'required' => false, + 'example' => 'lb-2zeur05gfs****', + 'maxItems' => 5, + ], + ], + [ + 'name' => 'LoadBalancerConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoadBalancerId' => [ + 'type' => 'string', + ], + 'Weight' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n" + ."\n" + .'This parameter value is returned only when Async is set to true. You can call the [DescribeScalingActivities](~~25961~~) operation to query the IDs of returned scaling activities and view the execution status of the scaling activities.'."\n", + 'type' => 'string', + 'example' => 'asa-bp140qd7mak8k63f****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp140qd7mak8k63f****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachLoadBalancersResponse>\\n <ScalingActivityId>asa-bp140qd7mak8k63f****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</AttachLoadBalancersResponse>","errorExample":""}]', + 'title' => 'AttachLoadBalancers', + 'description' => '## Description'."\n" + ."\n" + .'Before you associate an SLB instance with a scaling group, make sure that the following requirements are met:'."\n" + ."\n" + .'* The SLB instance and the scaling group must be in the same account.'."\n" + .'* The SLB instance and the scaling group must be in the same region.'."\n" + .'* The SLB instance must be in the Running state.'."\n" + .'* The SLB instance must be configured with at least one listener. Health check is enabled for the SLB instance.'."\n" + .'* The SLB instance and the scaling group must be in the same VPC if their network type is VPC.'."\n" + .'* If the network type of the scaling group is VPC, the network type of the SLB instance is classic network, and the SLB backend server contains VPC-type instances, the instance and the scaling group must be in the same VPC.'."\n" + .'* The number of SLB instances cannot exceed the quota for SLB instances that can be associated with the scaling group. For more information about the quota, see [Limits](~~25863~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DetachLoadBalancers' => [ + 'summary' => '移除一个或多个负载均衡CLB实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92691', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp1ffogfdauy0jw0****', + ], + ], + [ + 'name' => 'ForceDetach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove Elastic Compute Service (ECS) instances in the scaling group from the backend server groups of the SLB instance. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests.'."\n" + ."\n" + .'The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform asynchronous calls when you disassociates an SLB instance from the scaling group. Asynchronous calls ensure the transactional nature of operations. This means that the execution results take effect only if all operations are successfully performed. We recommend that you perform asynchronous calls.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: performs asynchronous calls. The request returns the ID of the scaling activity.'."\n" + .'* false: does not perform asynchronous calls.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LoadBalancer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the CLB instances. You can specify up to five instance IDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of SLB instance N. You can disassociate up to five SLB instances from a scaling group at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-2zeur05gfs****', + ], + 'required' => true, + 'example' => 'lb-2zeur05gfs****', + 'maxItems' => 5, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n" + ."\n" + .'A value of this parameter is returned only when Async is set to true. You can call the [DescribeScalingActivities](~~25961~~) operation to query the returned IDs of the scaling activities and view the execution status of the scaling activities.'."\n", + 'type' => 'string', + 'example' => 'asa-bp140qd7mak8k63f****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp140qd7mak8k63f****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachLoadBalancersResponse>\\n <ScalingActivityId>asa-bp140qd7mak8k63f****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DetachLoadBalancersResponse>","errorExample":""}]', + 'title' => 'DetachLoadBalancers', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DetachLoadBalancers\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DetachDBInstances' => [ + 'summary' => '移除一个或多个RDS实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92689', + 'abilityTreeNodes' => [ + 'FEATUREessJZ6DNF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'ForceDetach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove the private IP addresses of instances in the scaling group from the whitelist that manages access to the ApsaraDB RDS instance with which the scaling group is associated. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n" + ."\n" + .'The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'DBInstance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the ApsaraDB RDS instances. You can specify up to five ApsaraDB RDS instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of ApsaraDB RDS instance N. You can disassociate up to five ApsaraDB RDS instances from a scaling group at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp12cy3****', + ], + 'required' => true, + 'example' => 'rm-bp12cy3****', + 'maxItems' => 5, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'RemoveSecurityGroup', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachDBInstancesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DetachDBInstancesResponse>","errorExample":""}]', + 'title' => 'DetachDBInstances', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DetachDBInstances\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'AttachDBInstances' => [ + 'summary' => '添加一个或多个RDS实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92648', + 'abilityTreeNodes' => [ + 'FEATUREessJZ6DNF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1avr6ensitts3w****', + ], + ], + [ + 'name' => 'ForceAttach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to add the internal IP addresses of all instances in the specified scaling group to the whitelist that manages access to the ApsaraDB RDS instance. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n" + ."\n" + .'The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'DBInstance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the ApsaraDB RDS instances. You can specify up to five ApsaraDB RDS instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of ApsaraDB RDS instance N. Valid values of N: 1 to 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp12cy3****', + ], + 'required' => true, + 'example' => 'rm-bp12cy3****', + 'maxItems' => 5, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'AttachMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachDBInstancesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</AttachDBInstancesResponse>","errorExample":""}]', + 'title' => 'AttachDBInstances', + 'description' => '## Description'."\n" + ."\n" + .'Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:'."\n" + ."\n" + .'* The ApsaraDB RDS instance and the scaling group must be within the same account.'."\n" + .'* The ApsaraDB RDS instance must be unlocked. For more information about the lock policy, see [Limits](~~41872~~).'."\n" + .'* The ApsaraDB RDS instance must be in the Running state.'."\n" + ."\n" + .'After an ApsaraDB RDS instance is associated with the scaling group, the default whitelist that manages access to the ApsaraDB RDS instance can contain no more than 1,000 IP addresses. For more information, see the "Configure IP address whitelists for the RDS instance" section in the [Use a database client or the CLI to connect to an ApsaraDB RDS for MySQL instance](~~43185~~) topic.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'AttachVServerGroups' => [ + 'summary' => '添加负载均衡实例下虚拟服务器组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92651', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group. Example: cn-hangzhou or cn-shanghai. For more information, see [Regions and zones](~~40654~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ForceAttach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to add the ECS instances in the specified scaling group to the new VServer group.'."\n" + ."\n" + .'* true: adds the ECS instances to the VServer group.'."\n" + .'* false: does not add the ECS instances to the VServer group.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'VServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the vServer groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupAttribute' => [ + 'description' => 'Details of the vServer group attributes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => [ + 'description' => 'The ID of VServer group M. N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n" + ."\n" + .'M specifies the number of the VServer group that is associated with SLB instance N. Valid values of M: 1 to 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rsp-bp1jp1rge****', + ], + 'Weight' => [ + 'description' => 'The weight set for the ECS instances that are added to VServer group M. Valid values: 0 to 100.'."\n" + ."\n" + .'N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n" + ."\n" + .'M specifies the number of the VServer group that is associated with SLB instance N. Valid values of M: 1 to 5.'."\n" + ."\n" + .'Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number that is used by Auto Scaling to add the ECS instances to VServer group M. Valid values: 1 to 65535.'."\n" + ."\n" + .'N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n" + ."\n" + .'M specifies the number of the VServer group that is associated with SLB instance N. Valid values of M: 1 to 5.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'LoadBalancerId' => [ + 'description' => 'The ID of SLB instance N with which the VServer group is associated. N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-bp1u7etiogg38yvwz****', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachVServerGroupsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</AttachVServerGroupsResponse>","errorExample":""}]', + 'title' => 'AttachVServerGroups', + 'description' => '## Description'."\n" + ."\n" + .'Before you add a VServer group to a scaling group, make sure that the following requirements are met:'."\n" + ."\n" + .'* The SLB instance and the scaling group must be in the same account.'."\n" + .'* The SLB instance and the scaling group must be in the same region.'."\n" + .'* The SLB instance must be in the Running state.'."\n" + .'* The SLB instance must be configured with at least one listener. Health check is enabled for the SLB instance.'."\n" + .'* The SLB instance and the scaling group must be in the same VPC if the network type of both of them is VPC.'."\n" + .'* If the network type of the scaling group is VPC, the network type of the SLB instance is classic network, and the VServer group contains VPC-type instances, the instance and the scaling group must be in the same VPC.'."\n" + .'* The VServer group to be added to the scaling group must be associated with the SLB instance.'."\n" + .'* The number of VServer groups cannot exceed the quota for VServer groups in the scaling group. For more information about the quota, see [Limits](~~25863~~).'."\n" + ."\n" + .'You must set the following parameters to specify the VServer groups to be added:'."\n" + ."\n" + .'* VServerGroup.N.LoadBalancerId: the ID of the SLB instance'."\n" + .'* VServerGroup.N.VServerGroupAttribute.N.VServerGroupId: the ID of the VServer group'."\n" + .'* VServerGroup.N.VServerGroupAttribute.N.Port: the port number of the VServer group'."\n" + ."\n" + .'If you use different ports to add a VServer group to a scaling group, Auto Scaling considers that multiple VServer groups are added to the scaling group. If multiple VServer groups with the same group ID and port number are specified in the request parameters, only the first VServer group is used. The other VServer groups are ignored.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DetachVServerGroups' => [ + 'summary' => '移除一个或者多个虚拟服务器组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92692', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group. Example: cn-hangzhou or cn-shanghai. For more information, see [Regions and zones](~~40654~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1fo0dbtsbmqa9h****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ForceDetach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove the ECS instances in the specified scaling group from the VServer group to be removed.'."\n" + ."\n" + .'* true: removes the ECS instances.'."\n" + .'* false: does not remove the ECS instances.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'VServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the vServer groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupAttribute' => [ + 'description' => 'Details of the vServer group attributes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => [ + 'description' => 'The ID of VServer group M.'."\n" + ."\n" + .'N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n" + ."\n" + .'M specifies the number of the VServer group that is associated with SLB instance N. Valid values of M: 1 to 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rsp-bp1jp1rge****', + ], + 'Port' => [ + 'description' => 'The port number that is used by Auto Scaling to add the ECS instances to VServer group M. Valid values: 1 to 65535.'."\n" + ."\n" + .'N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n" + ."\n" + .'M specifies the number of the VServer group that is associated with the SLB instance. Valid values of M: 1 to 5.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'LoadBalancerId' => [ + 'description' => 'The ID of SLB instance N with which the VServer group is associated.'."\n" + ."\n" + .'N specifies the number of the SLB instance. Valid values of N: 1 to 5.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-bp1p90y3ya9h8s62d****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachVServerGroupsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DetachVServerGroupsResponse>","errorExample":""}]', + 'title' => 'DetachVServerGroups', + 'description' => '## Description'."\n" + ."\n" + .'You must set the following parameters to specify the VServer groups to be removed:'."\n" + ."\n" + .'* VServerGroup.N.LoadBalancerId: the ID of the SLB instance'."\n" + .'* VServerGroup.N.VServerGroupAttribute.N.VServerGroupId: the ID of the VServer group'."\n" + .'* VServerGroup.N.VServerGroupAttribute.N.Port: the port number of the VServer group'."\n" + ."\n" + .'If the VServer groups specified in the request parameters match VServer groups in the scaling group, the matched VServer groups are removed. If no VServer groups specified in the request parameters match VServer groups in the scaling group, the request is ignored and no error is reported.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeScalingGroups' => [ + 'summary' => '查询伸缩组列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92683', + 'abilityTreeNodes' => [ + 'FEATUREess7569XW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'enumValueTitles' => [ + 10 => '10', + ], + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.1', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.1 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.2', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.2 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.3', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.3 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.4', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.4 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.5', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.5 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.6', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.6 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.7', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.7 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.8', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.8 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.9', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.9 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.10', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.10 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.11', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.11 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.12', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.12 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.13', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.13 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.14', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.14 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.15', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.15 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.16', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.16 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.17', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.17 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.18', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.18 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.19', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.19 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'ScalingGroupName.20', + 'in' => 'query', + 'schema' => [ + 'description' => 'ScalingGroupName.20 is the name of the scaling group that you want to query. The query result does not contain the names of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup****', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instances that are managed by the scaling group. Valid values:'."\n" + ."\n" + .'* ECS: Elastic Compute Service (ECS) instances'."\n" + .'* ECI: elastic container instances'."\n" + ."\n" + .'Default value: ECS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the scaling groups that you want to query.'."\n" + ."\n" + .'The query result does not contain the IDs of inactive scaling groups, and no errors are returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of scaling group N that you want to query. Valid values of N: 1 to 20. The query result does not contain the IDs of inactive scaling groups, and no errors are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + 'required' => false, + 'example' => 'asg-bp14wlu85wrpchm0****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the scaling group that you want to query belongs.'."\n" + ."\n" + .'> If the specified resource group does not contain scaling groups, null is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-123****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of scaling groups.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScalingGroup' => [ + 'description' => 'Details of the scaling groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) in which the scaling group resides.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1vwnn14rqpyiczj****', + ], + 'CreationTime' => [ + 'description' => 'The time when the scaling group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2014-08-14T10:58Z', + ], + 'TotalInstanceCount' => [ + 'description' => 'The total number of ECS instances in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingGroupName' => [ + 'description' => 'The name of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'dyrSuvBOtO1dEdIlIbp****', + ], + 'SpotInstancePools' => [ + 'description' => 'The number of instance types that are specified. Auto Scaling creates preemptible instances of multiple instance types that are provided at the lowest price. Valid values: 0 to 10.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter to `COMPOSABLE`, the default value of this parameter is 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'StoppedCapacity' => [ + 'description' => 'The number of instances that were stopped in Economical Mode in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OnDemandPercentageAboveBaseCapacity' => [ + 'description' => 'The percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances is reached. The **OnDemandBaseCapacity** parameter specifies the minimum number of pay-as-you-go instances that must be contained in the scaling group. Valid values: 0 to 100.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter to `COMPOSABLE`, the default value of this parameter is 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ModificationTime' => [ + 'description' => 'The time when the scaling group was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2014-08-14T10:58Z', + ], + 'MinSize' => [ + 'description' => 'The minimum number of ECS instances that must be contained in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + 'CompensateWithOnDemand' => [ + 'description' => 'Indicates whether pay-as-you-go instances can be automatically created to meet the requirement on the number of ECS instances when the expected capacity of preemptible instances cannot be provided due to reasons such as cost-related issues and insufficient resources. This parameter is available only if you set the `MultiAZPolicy` parameter to `COST_OPTIMIZED`. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ScalingPolicy' => [ + 'description' => 'The reclaim mode of the scaling group. Valid values:'."\n" + ."\n" + .'* recycle: economical mode'."\n" + .'* release: release mode'."\n" + ."\n" + .'For information about how to remove instances, see the [RemoveInstances](~~25955~~) topic.'."\n", + 'type' => 'string', + 'example' => 'recycle', + ], + 'RemovingWaitCapacity' => [ + 'description' => 'The number of ECS instances that are in the **Pending Remove** state in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ActiveCapacity' => [ + 'description' => 'The number of ECS instances that are in the **In Service** state in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OnDemandBaseCapacity' => [ + 'description' => 'The minimum number of pay-as-you-go instances that must be contained in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances in the scaling group is less than the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances.'."\n" + ."\n" + .'If you set the `MultiAZPolicy` parameter to `COMPOSABLE`, the default value of this parameter is 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ProtectedCapacity' => [ + 'description' => 'The number of ECS instances that are in the **Protected** state in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HealthCheckType' => [ + 'description' => 'The health check mode of the scaling group. Valid values:'."\n" + ."\n" + .'* NONE: Auto Scaling does not perform health checks.'."\n" + .'* ECS: Auto Scaling performs health checks on ECS instances in the scaling group.'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'LifecycleState' => [ + 'description' => 'The status of the scaling group. Valid values:'."\n" + ."\n" + .'* Active: The scaling group is active. Scaling groups that are in the **Active** state can receive requests to execute scaling rules and trigger scaling activities.'."\n" + .'* Inactive: The scaling group is inactive. Scaling groups that are in the **Inactive** state cannot receive requests to execute scaling rules.'."\n" + .'* Deleting: The scaling group is being deleted. Scaling groups that are being deleted cannot receive requests to execute scaling rules. In addition, the parameter settings of the scaling groups cannot be modified.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'GroupDeletionProtection' => [ + 'description' => 'Indicates whether deletion protection is enabled for the scaling group. Valid values:'."\n" + ."\n" + .'* true: Deletion protection is enabled for the scaling group. The scaling group cannot be deleted.'."\n" + .'* false: Deletion protection is disabled for the scaling group.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ActiveScalingConfigurationId' => [ + 'description' => 'The ID of the active scaling configuration in the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asc-bp1et2qekq3ojr33****', + ], + 'GroupType' => [ + 'description' => 'The type of the instances that are managed by the scaling group.'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'MultiAZPolicy' => [ + 'description' => 'The scaling policy for the multi-zone scaling group that contains ECS instances. Valid values:'."\n" + ."\n" + .'* PRIORITY: ECS instances are created based on the value of the VSwitchIds.N parameter. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.'."\n" + ."\n" + .'* COST_OPTIMIZED: ECS instances are created based on the unit price of vCPUs. Auto Scaling preferentially creates ECS instances whose vCPUs have the lowest price. If you specified preemptible instance types in the scaling configuration, Auto Scaling preferentially creates preemptible instances. You can use the **CompensateWithOnDemand** parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** The COST_OPTIMIZED setting takes effect only when multiple instance types are specified or preemptible instances are used.'."\n" + ."\n" + .'* BALANCE: ECS instances are evenly distributed across the zones that are specified for the scaling group. If ECS instances are unevenly distributed across zones due to insufficient resources, you can call the [RebalanceInstance](~~71516~~) operation to evenly redistribute the instances across the zones.'."\n" + ."\n" + .'* COMPOSABLE: You can combine the preceding policies based on your business requirements.'."\n", + 'type' => 'string', + 'example' => 'PRIORITY', + ], + 'RemovingCapacity' => [ + 'description' => 'The number of ECS instances that are being removed from the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PendingWaitCapacity' => [ + 'description' => 'The number of ECS instances in the **Pending Add** state in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StandbyCapacity' => [ + 'description' => 'The number of instances that are in the **Standby** state in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PendingCapacity' => [ + 'description' => 'The number of ECS instances that are being added to the scaling group and still being configured.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LaunchTemplateId' => [ + 'description' => 'The ID of the launch template that is used by the scaling group.'."\n", + 'type' => 'string', + 'example' => 'lt-m5e3ofjr1zn1aw7****', + ], + 'TotalCapacity' => [ + 'description' => 'The total weighted capacity of all ECS instances in the scaling group if the **WeightedCapacity** parameter is specified. In other cases, the value of this parameter indicates the total number of ECS instances in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DesiredCapacity' => [ + 'description' => 'The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SpotInstanceRemedy' => [ + 'description' => 'Indicates whether preemptible instances can be supplemented. If this parameter is set to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives a system message which indicates that the preemptible instance is to be reclaimed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LaunchTemplateVersion' => [ + 'description' => 'The version of the launch template that is used by the scaling group.'."\n", + 'type' => 'string', + 'example' => 'Default', + ], + 'RegionId' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch that is associated with the scaling group.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1whw2u46cn8zubm****', + ], + 'MaxSize' => [ + 'description' => 'The maximum number of ECS instances that can be contained in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DefaultCooldown' => [ + 'description' => 'The cooldown period of the scaling group. During the cooldown period, Auto Scaling executes only the scaling activities that are triggered by [CloudMonitor](~~35170~~) event-triggered tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'VServerGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VServerGroup' => [ + 'description' => 'The backend vServer groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LoadBalancerId' => [ + 'description' => 'The ID of the Server Load Balancer (SLB) instance to which the backend vServer group belongs.'."\n", + 'type' => 'string', + 'example' => '147b46d767c-cn-qingdao-cm5****', + ], + 'VServerGroupAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VServerGroupAttribute' => [ + 'description' => 'The attributes of the backend vServer groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VServerGroupId' => [ + 'description' => 'The ID of the backend vServer group.'."\n", + 'type' => 'string', + 'example' => 'rsp-bp12bjrny****', + ], + 'Weight' => [ + 'description' => 'The weight of the backend vServer group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Port' => [ + 'description' => 'The port number that is used by the SLB instance to provide external services.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'LaunchTemplateOverrides' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LaunchTemplateOverride' => [ + 'description' => 'The information about the instance types that are specified by using the Extended Configurations feature of the launch template.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WeightedCapacity' => [ + 'description' => 'The weight of the instance type. The value of this parameter indicates the capacity of a single instance of the specified instance type in the scaling group. A greater weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'InstanceType' => [ + 'description' => 'The instance type. The instance type that is specified by this parameter overrides the instance type that is specified in the launch template.', + 'type' => 'string', + 'example' => 'ecs.c5.xlarge', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum bid price of the instance type that is specified by the ``InstanceType`` parameter. You can specify 1 to 10 instance types by using the Extended Configurations feature of the launch template.'."\n" + ."\n" + .'>This parameter is available only if you specify the LaunchTemplateId parameter.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.025', + ], + ], + ], + ], + ], + ], + 'AlbServerGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlbServerGroup' => [ + 'description' => 'Details of Application Load Balancer (ALB) server groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AlbServerGroupId' => [ + 'description' => 'The ID of the ALB server group.'."\n", + 'type' => 'string', + 'example' => 'sgp-ddwb0y0g6y9bjm****', + ], + 'Weight' => [ + 'description' => 'The weight of an ECS instance after Auto Scaling adds the ECS instance to the ALB server group as a backend server.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number that is used by an ECS instance after Auto Scaling adds the ECS instance to the ALB server group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + ], + ], + 'ServerGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServerGroup' => [ + 'description' => 'The ID of the server group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ServerGroupId' => [ + 'description' => 'The ID of the backend vServer group.', + 'type' => 'string', + 'example' => 'sgp-i9ouakeaerr*****', + ], + 'Type' => [ + 'description' => 'The type of the vulnerability. Set the value to **cve**, which indicates image vulnerabilities.'."\n", + 'type' => 'string', + 'example' => 'ALB', + ], + 'Weight' => [ + 'description' => 'The weight of the backend vServer group.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number that is used by the SLB instance to provide external services.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + ], + ], + 'RemovalPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RemovalPolicy' => [ + 'description' => 'The instance removal policies. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + .'* CustomPolicy: removes ECS instances based on the custom scale-in policy (Function).'."\n" + ."\n" + .'The scaling configuration source specified by the OldestScalingConfiguration setting can be a scaling configuration or a launch template. The CustomPolicy setting takes effect only if you specify it as the first step to remove instances. If you specify CustomPolicy, you must also specify the CustomPolicyARN parameter.'."\n" + ."\n" + .'> The removal of ECS instances from a scaling group is also affected by the value of the MultiAZPolicy parameter. For more information, see the [Configure a combination policy for removing instances](~~254822~~) topic.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance removal policies. Valid values:'."\n" + ."\n" + .'* OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group.'."\n" + .'* NewestInstance: removes ECS instances that are most recently added to the scaling group.'."\n" + .'* OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.'."\n" + .'* CustomPolicy: removes ECS instances based on the custom scale-in policy (Function).'."\n" + ."\n" + .'The scaling configuration source specified by the OldestScalingConfiguration setting can be a scaling configuration or a launch template. The CustomPolicy setting takes effect only if you specify it as the first step to remove instances. If you specify CustomPolicy, you must also specify the CustomPolicyARN parameter.'."\n" + ."\n" + .'> The removal of ECS instances from a scaling group is also affected by the value of the MultiAZPolicy parameter. For more information, see the [Configure a combination policy for removing instances](~~254822~~) topic.'."\n", + 'type' => 'string', + 'example' => 'OldestScalingConfiguration', + ], + ], + ], + ], + 'DBInstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The IDs of the ApsaraDB RDS instances that you want to associate with the scaling group. The value can be a JSON array that contains multiple ApsaraDB RDS instance IDs. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'You can associate only a limited number of ApsaraDB RDS instances with a scaling group. Go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the maximum number of ApsaraDB RDS instances that you can associate with a scaling group.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the ApsaraDB RDS instances that you want to associate with the scaling group. The value can be a JSON array that contains multiple ApsaraDB RDS instance IDs. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'You can associate only a limited number of ApsaraDB RDS instances with a scaling group. Go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check the maximum number of ApsaraDB RDS instances that you can associate with a scaling group.'."\n", + 'type' => 'string', + 'example' => 'rm-bp15556qzebg1****', + ], + ], + ], + ], + 'LoadBalancerIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LoadBalancerId' => [ + 'description' => 'The IDs of the SLB instances that are associated with the scaling group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the SLB instances that are associated with the scaling group.', + 'type' => 'string', + 'example' => 'lb-bp19byhscefk3x0li****', + ], + ], + ], + ], + 'VSwitchIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The IDs of the vSwitches that are associated with the scaling group. If you specify the VSwitchIds parameter, the VSwitchId parameter is ignored.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the vSwitch that is associated with the scaling group. If you specify the VSwitchIds parameter, the VSwitchId parameter is ignored.', + 'type' => 'string', + 'example' => 'vsw-bp1whw2u46cn8zubm****', + ], + ], + ], + ], + 'SuspendedProcesses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SuspendedProcess' => [ + 'description' => 'The processes that are suspended. If no process is suspended, null is returned. Valid values:'."\n" + ."\n" + .'- ScaleIn: scale-in'."\n" + .'- ScaleOut: scale-out'."\n" + .'- HealthCheck: health check'."\n" + .'- AlarmNotification: event-triggered task'."\n" + .'- ScheduledAction: scheduled task', + 'type' => 'array', + 'items' => [ + 'description' => 'The processes that are suspended. If no process is suspended, null is returned. Valid values:'."\n" + ."\n" + .'- ScaleIn: scale-in'."\n" + .'- ScaleOut: scale-out'."\n" + .'- HealthCheck: health check'."\n" + .'- AlarmNotification: event-triggered task'."\n" + .'- ScheduledAction: scheduled task', + 'type' => 'string', + 'example' => 'ScaleIn', + ], + ], + ], + ], + 'SystemSuspended' => [ + 'description' => 'Indicates whether Auto Scaling stops executing scaling activities in the scaling group. Valid values:'."\n" + ."\n" + .'- true: If the scaling activities fail for more than seven consecutive days, Auto Scaling stops executing scaling activities in the scaling group. You must modify the scaling group or scaling configuration to resume the execution of the scaling activities.'."\n" + .'- false: Auto Scaling does not stop executing scaling activities in the scaling group.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MonitorGroupId' => [ + 'description' => 'The ID of the CloudMonitor application group that is associated with the scaling group.', + 'type' => 'string', + 'example' => '1497****', + ], + 'AzBalance' => [ + 'description' => 'Specifies whether to evenly distribute instances in the scaling group across zones. This parameter is available only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AllocationStrategy' => [ + 'description' => 'The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create the required number of instances. The policy can be applied to pay-as-you-go instances and preemptible instances. This parameter takes effect only when you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* priority: Auto Scaling selects instance types based on the specified order of the instance types to create the required number of instances.'."\n" + .'* lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of instances.'."\n" + ."\n" + .'Default value: priority.'."\n", + 'type' => 'string', + 'example' => 'priority', + ], + 'SpotAllocationStrategy' => [ + 'description' => 'The allocation policy of preemptible instances. You can use this parameter to individually specify the allocation policy of preemptible instances. This parameter takes effect only if you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:'."\n" + ."\n" + .'* priority: Auto Scaling selects instance types based on the specified order of the instance types to create the required number of preemptible instances.'."\n" + .'* lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of preemptible instances.'."\n" + ."\n" + .'Default value: priority.'."\n", + 'type' => 'string', + 'example' => 'lowestPrice', + ], + 'MaxInstanceLifetime' => [ + 'description' => 'The maximum life span of an instance in the scaling group. Unit: seconds.'."\n" + ."\n" + .'Valid values: 86400 to the value of the Integer.maxValue parameter.'."\n" + ."\n" + .'Default value: null.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'CustomPolicyARN' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function). This parameter is available only if you specify CustomPolicy as the first step to remove instances.'."\n", + 'type' => 'string', + 'example' => 'acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name', + ], + 'InitCapacity' => [ + 'description' => 'The number of instances that are in the Initialized state before the instances are added to the scaling group.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-123****', + ], + 'LoadBalancerConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LoadBalancerConfig' => [ + 'description' => 'List of CLB (formerly SLB) configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoadBalancerId' => [ + 'type' => 'string', + 'example' => 'lb-2zetlvztvf8952wt8m106', + 'description' => 'The IDs of the SLB instances that are associated with the scaling group.', + ], + 'Weight' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'The weight of an ECS instance after Auto Scaling adds the ECS instance to the ALB server group as a backend server.', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'EnableDesiredCapacity' => [ + 'type' => 'boolean', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'type' => 'string', + ], + 'TagValue' => [ + 'type' => 'string', + ], + 'Propagate' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'HealthCheckTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HealthCheckType' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'DBInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstance' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + 'SecurityGroupIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityGroupId' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SpotCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'StopInstanceTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CapacityOptions' => [ + 'type' => 'object', + 'properties' => [ + 'OnDemandBaseCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'OnDemandPercentageAboveBaseCapacity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CompensateWithOnDemand' => [ + 'type' => 'boolean', + ], + 'SpotAutoReplaceOnDemand' => [ + 'type' => 'boolean', + ], + 'PriceComparisonMode' => [ + 'type' => 'string', + ], + ], + ], + 'BalanceMode' => [ + 'title' => '负载均衡模式', + 'type' => 'string', + ], + 'AutoRebalance' => [ + 'title' => '自动平衡伸缩组', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"ScalingGroups\\": {\\n \\"ScalingGroup\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1vwnn14rqpyiczj****\\",\\n \\"CreationTime\\": \\"2014-08-14T10:58Z\\",\\n \\"TotalInstanceCount\\": 1,\\n \\"ScalingGroupName\\": \\"dyrSuvBOtO1dEdIlIbp****\\",\\n \\"SpotInstancePools\\": 5,\\n \\"StoppedCapacity\\": 1,\\n \\"OnDemandPercentageAboveBaseCapacity\\": 20,\\n \\"ModificationTime\\": \\"2014-08-14T10:58Z\\",\\n \\"MinSize\\": 1,\\n \\"ScalingGroupId\\": \\"asg-bp14wlu85wrpchm0****\\",\\n \\"CompensateWithOnDemand\\": true,\\n \\"ScalingPolicy\\": \\"recycle\\",\\n \\"RemovingWaitCapacity\\": 1,\\n \\"ActiveCapacity\\": 1,\\n \\"OnDemandBaseCapacity\\": 30,\\n \\"ProtectedCapacity\\": 1,\\n \\"HealthCheckType\\": \\"ECS\\",\\n \\"LifecycleState\\": \\"Active\\",\\n \\"GroupDeletionProtection\\": true,\\n \\"ActiveScalingConfigurationId\\": \\"asc-bp1et2qekq3ojr33****\\",\\n \\"GroupType\\": \\"ECS\\",\\n \\"MultiAZPolicy\\": \\"PRIORITY\\",\\n \\"RemovingCapacity\\": 0,\\n \\"PendingWaitCapacity\\": 1,\\n \\"StandbyCapacity\\": 1,\\n \\"PendingCapacity\\": 0,\\n \\"LaunchTemplateId\\": \\"lt-m5e3ofjr1zn1aw7****\\",\\n \\"TotalCapacity\\": 1,\\n \\"DesiredCapacity\\": 5,\\n \\"SpotInstanceRemedy\\": true,\\n \\"LaunchTemplateVersion\\": \\"Default\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"VSwitchId\\": \\"vsw-bp1whw2u46cn8zubm****\\",\\n \\"MaxSize\\": 2,\\n \\"DefaultCooldown\\": 60,\\n \\"VServerGroups\\": {\\n \\"VServerGroup\\": [\\n {\\n \\"LoadBalancerId\\": \\"147b46d767c-cn-qingdao-cm5****\\",\\n \\"VServerGroupAttributes\\": {\\n \\"VServerGroupAttribute\\": [\\n {\\n \\"VServerGroupId\\": \\"rsp-bp12bjrny****\\",\\n \\"Weight\\": 1,\\n \\"Port\\": 22\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"LaunchTemplateOverrides\\": {\\n \\"LaunchTemplateOverride\\": [\\n {\\n \\"WeightedCapacity\\": 4,\\n \\"InstanceType\\": \\"ecs.c5.xlarge\\",\\n \\"SpotPriceLimit\\": 0.025\\n }\\n ]\\n },\\n \\"AlbServerGroups\\": {\\n \\"AlbServerGroup\\": [\\n {\\n \\"AlbServerGroupId\\": \\"sgp-ddwb0y0g6y9bjm****\\",\\n \\"Weight\\": 100,\\n \\"Port\\": 80\\n }\\n ]\\n },\\n \\"ServerGroups\\": {\\n \\"ServerGroup\\": [\\n {\\n \\"ServerGroupId\\": \\"sgp-i9ouakeaerr*****\\",\\n \\"Type\\": \\"ALB\\",\\n \\"Weight\\": 100,\\n \\"Port\\": 80\\n }\\n ]\\n },\\n \\"RemovalPolicies\\": {\\n \\"RemovalPolicy\\": [\\n \\"OldestScalingConfiguration\\"\\n ]\\n },\\n \\"DBInstanceIds\\": {\\n \\"DBInstanceId\\": [\\n \\"rm-bp15556qzebg1****\\"\\n ]\\n },\\n \\"LoadBalancerIds\\": {\\n \\"LoadBalancerId\\": [\\n \\"lb-bp19byhscefk3x0li****\\"\\n ]\\n },\\n \\"VSwitchIds\\": {\\n \\"VSwitchId\\": [\\n \\"vsw-bp1whw2u46cn8zubm****\\"\\n ]\\n },\\n \\"SuspendedProcesses\\": {\\n \\"SuspendedProcess\\": [\\n \\"ScaleIn\\"\\n ]\\n },\\n \\"SystemSuspended\\": true,\\n \\"MonitorGroupId\\": \\"1497****\\",\\n \\"AzBalance\\": false,\\n \\"AllocationStrategy\\": \\"priority\\",\\n \\"SpotAllocationStrategy\\": \\"lowestPrice\\",\\n \\"MaxInstanceLifetime\\": 0,\\n \\"CustomPolicyARN\\": \\"acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name\\",\\n \\"InitCapacity\\": 0,\\n \\"ResourceGroupId\\": \\"rg-123****\\",\\n \\"LoadBalancerConfigs\\": {\\n \\"LoadBalancerConfig\\": [\\n {\\n \\"LoadBalancerId\\": \\"147b46d767c-cn-qingdao-cm5****\\",\\n \\"Weight\\": 10\\n }\\n ]\\n },\\n \\"EnableDesiredCapacity\\": false,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"Department\\",\\n \\"TagValue\\": \\"Finance\\",\\n \\"Propagate\\": false\\n }\\n ]\\n },\\n \\"HealthCheckTypes\\": {\\n \\"HealthCheckType\\": [\\n \\"ECS\\"\\n ]\\n },\\n \\"DBInstances\\": {\\n \\"DBInstance\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-m5eqju85s45mu0***\\",\\n \\"Type\\": \\"RDS\\",\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-uf65zt66cf2a0q47***\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"SpotCapacity\\": 0,\\n \\"StopInstanceTimeout\\": 60,\\n \\"CapacityOptions\\": {\\n \\"OnDemandBaseCapacity\\": 0,\\n \\"OnDemandPercentageAboveBaseCapacity\\": 0,\\n \\"CompensateWithOnDemand\\": true,\\n \\"SpotAutoReplaceOnDemand\\": false,\\n \\"PriceComparisonMode\\": \\"PricePerUnit\\"\\n },\\n \\"BalanceMode\\": \\"BalancedBestEffort\\",\\n \\"AutoRebalance\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeScalingGroupsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <ScalingGroups>\\n <VpcId>vpc-bp1vwnn14rqpyiczj****</VpcId>\\n <CreationTime>2014-08-14T10:58Z</CreationTime>\\n <TotalInstanceCount>1</TotalInstanceCount>\\n <ScalingGroupName>dyrSuvBOtO1dEdIlIbp****</ScalingGroupName>\\n <SpotInstancePools>5</SpotInstancePools>\\n <StoppedCapacity>1</StoppedCapacity>\\n <OnDemandPercentageAboveBaseCapacity>20</OnDemandPercentageAboveBaseCapacity>\\n <ModificationTime>2014-08-14T10:58Z</ModificationTime>\\n <MinSize>1</MinSize>\\n <ScalingGroupId>asg-bp14wlu85wrpchm0****</ScalingGroupId>\\n <CompensateWithOnDemand>true</CompensateWithOnDemand>\\n <ScalingPolicy>recycle</ScalingPolicy>\\n <RemovingWaitCapacity>1</RemovingWaitCapacity>\\n <ActiveCapacity>1</ActiveCapacity>\\n <OnDemandBaseCapacity>30</OnDemandBaseCapacity>\\n <ProtectedCapacity>1</ProtectedCapacity>\\n <HealthCheckType>ECS</HealthCheckType>\\n <LifecycleState>Active</LifecycleState>\\n <GroupDeletionProtection>true</GroupDeletionProtection>\\n <ActiveScalingConfigurationId>asc-bp1et2qekq3ojr33****</ActiveScalingConfigurationId>\\n <GroupType>ECS</GroupType>\\n <MultiAZPolicy>PRIORITY</MultiAZPolicy>\\n <RemovingCapacity>0</RemovingCapacity>\\n <PendingWaitCapacity>1</PendingWaitCapacity>\\n <StandbyCapacity>1</StandbyCapacity>\\n <PendingCapacity>0</PendingCapacity>\\n <LaunchTemplateId>lt-m5e3ofjr1zn1aw7****</LaunchTemplateId>\\n <TotalCapacity>1</TotalCapacity>\\n <DesiredCapacity>5</DesiredCapacity>\\n <SpotInstanceRemedy>true</SpotInstanceRemedy>\\n <LaunchTemplateVersion>Default</LaunchTemplateVersion>\\n <RegionId>cn-qingdao</RegionId>\\n <VSwitchId>vsw-bp1whw2u46cn8zubm****</VSwitchId>\\n <MaxSize>2</MaxSize>\\n <DefaultCooldown>60</DefaultCooldown>\\n <VServerGroups>\\n <LoadBalancerId>147b46d767c-cn-qingdao-cm5****</LoadBalancerId>\\n <VServerGroupAttributes>\\n <VServerGroupId>rsp-bp12bjrny****</VServerGroupId>\\n <Weight>1</Weight>\\n <Port>22</Port>\\n </VServerGroupAttributes>\\n </VServerGroups>\\n <LaunchTemplateOverrides>\\n <WeightedCapacity>4</WeightedCapacity>\\n <InstanceType>ecs.c5.xlarge</InstanceType>\\n <SpotPriceLimit>0.025</SpotPriceLimit>\\n </LaunchTemplateOverrides>\\n <AlbServerGroups>\\n <AlbServerGroupId>sgp-ddwb0y0g6y9bjm****</AlbServerGroupId>\\n <Weight>100</Weight>\\n <Port>80</Port>\\n </AlbServerGroups>\\n <ServerGroups>\\n <ServerGroupId>sgp-i9ouakeaerr*****</ServerGroupId>\\n <Type>ALB</Type>\\n <Weight>100</Weight>\\n <Port>80</Port>\\n </ServerGroups>\\n <RemovalPolicies>OldestScalingConfiguration</RemovalPolicies>\\n <DBInstanceIds>rm-bp15556qzebg1****</DBInstanceIds>\\n <LoadBalancerIds>lb-bp19byhscefk3x0li****</LoadBalancerIds>\\n <VSwitchIds>vsw-bp1whw2u46cn8zubm****</VSwitchIds>\\n <SuspendedProcesses>ScaleIn</SuspendedProcesses>\\n <SystemSuspended>true</SystemSuspended>\\n <MonitorGroupId>1497****</MonitorGroupId>\\n <AzBalance>false</AzBalance>\\n <AllocationStrategy>priority</AllocationStrategy>\\n <SpotAllocationStrategy>lowestPrice</SpotAllocationStrategy>\\n <CustomPolicyARN>acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name</CustomPolicyARN>\\n <InitCapacity>0</InitCapacity>\\n <ResourceGroupId>rg-123****</ResourceGroupId>\\n <LoadBalancerConfigs>\\n <LoadBalancerId>147b46d767c-cn-qingdao-cm5****</LoadBalancerId>\\n <Weight>10</Weight>\\n </LoadBalancerConfigs>\\n <EnableDesiredCapacity>false</EnableDesiredCapacity>\\n <Tags>\\n <TagKey>Department</TagKey>\\n <TagValue>Finance</TagValue>\\n <Propagate>false</Propagate>\\n </Tags>\\n <HealthCheckTypes>ECS</HealthCheckTypes>\\n <DBInstances>\\n <DBInstanceId>rm-m5eqju85s45mu0***</DBInstanceId>\\n <Type>RDS</Type>\\n <SecurityGroupIds>sg-uf65zt66cf2a0q47***</SecurityGroupIds>\\n </DBInstances>\\n <SpotCapacity>0</SpotCapacity>\\n <StopInstanceTimeout>60</StopInstanceTimeout>\\n <CapacityOptions>\\n <OnDemandBaseCapacity>0</OnDemandBaseCapacity>\\n <OnDemandPercentageAboveBaseCapacity>0</OnDemandPercentageAboveBaseCapacity>\\n <CompensateWithOnDemand>true</CompensateWithOnDemand>\\n <SpotAutoReplaceOnDemand>false</SpotAutoReplaceOnDemand>\\n </CapacityOptions>\\n </ScalingGroups>\\n</DescribeScalingGroupsResponse>","errorExample":""}]', + 'title' => 'DescribeScalingGroups', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeScalingGroups\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeScalingInstances' => [ + 'summary' => '查询伸缩组内ECS实例列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92684', + 'abilityTreeNodes' => [ + 'FEATUREessPMOEEX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the associated scaling configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc-bp1i65jd06v04vdh****', + ], + ], + [ + 'name' => 'HealthStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The health status of the ECS instance in the scaling group. If ECS instances do not run as expected, Auto Scaling considers the ECS instances unhealthy. Valid values:'."\n" + ."\n" + .'* Healthy'."\n" + .'* Unhealthy'."\n" + ."\n" + .'Auto Scaling automatically removes unhealthy ECS instances from the scaling group and then releases automatically created instances among the unhealthy instances.'."\n" + ."\n" + .'Unhealthy ECS instances that are manually added to the scaling group are released based on the management mode of the instance lifecycles. If the lifecycles of the ECS instances are not managed by the scaling group, Auto Scaling removes the instances from the scaling group but does not release the instances. If the lifecycles of the ECS instances are managed by the scaling group, Auto Scaling removes the instances from the scaling group and releases the instances.'."\n" + ."\n" + .'> Make sure that you have sufficient balance within your Alibaba Cloud account. If you have overdue payments within your Alibaba Cloud account, pay-as-you-go and preemptible instances are stopped or released. For information about how the states of ECS instances with overdue payments change, see [Overdue payments](~~170589~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Healthy', + ], + ], + [ + 'name' => 'LifecycleState', + 'in' => 'query', + 'schema' => [ + 'description' => 'The lifecycle state of the ECS instance in the scaling group. Valid values:'."\n" + ."\n" + .'* InService: The ECS instance is added to the scaling group and provides services as expected.'."\n" + .'* Pending: The ECS instance is being added to the scaling group. During this process, Auto Scaling adds the ECS instance to the backend server groups of the associated Classic Load Balancer (CLB) instance and adds the private IP address of the ECS instance to the IP address whitelist of the associated ApsaraDB RDS instance.'."\n" + .'* Pending:Wait: The ECS instance is waiting to be added to the scaling group. If a lifecycle hook that applies to scale-out activities is created for the scaling group, the ECS instance enters the Pending:Wait state. The ECS instance is added to the scaling group only after the lifecycle hook times out.'."\n" + .'* Protected: The ECS instance is being protected. The ECS instance can provide services as expected. However, Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage the lifecycle of the ECS instance.'."\n" + .'* Standby: The ECS instance is on standby. The ECS instance is out of service and the weight of the ECS instance as a backend server is set to zero. Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage the lifecycle of the ECS instance.'."\n" + .'* Stopped: The ECS instance is stopped. The ECS instance is stopped and cannot provide services.'."\n" + .'* Removing: The ECS instance is being removed from the scaling group. During this process, Auto Scaling removes the ECS instance from the backend server groups of the associated CLB instance and removes the IP address of the ECS instance from the IP address whitelist of the associated ApsaraDB RDS instance.'."\n" + .'* Removing:Wait: The ECS instance is waiting to be removed from the scaling group. If a lifecycle hook that applies to scale-in activities is created for the scaling group, the ECS instance enters the Removing:Wait state. The ECS instance is removed from the scaling group only after the lifecycle hook times out.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'InService', + ], + ], + [ + 'name' => 'CreationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies how the ECS instance is created. Valid values:'."\n" + ."\n" + .'* AutoCreated: The ECS instance is automatically created by Auto Scaling based on the instance configuration source of the scaling group.'."\n" + .'* Attached: The ECS instance is manually added to the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoCreated', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingActivityId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asa-bp1c9djwrgxjyk31****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the ECS instances. You can specify 1 to 20 instance IDs.'."\n" + ."\n" + .'Invalid instance IDs are not displayed in the query result, and no error is reported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp109k5j3dum1ce6****', + ], + 'required' => false, + 'example' => 'i-bp109k5j3dum1ce6****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CreationTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'LifecycleStates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B13527BF-1FBD-4334-A512-20F5E9D3****', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalSpotCount' => [ + 'description' => 'The total number of preemptible instances that run as expected in the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'TotalCount' => [ + 'description' => 'The total number of ECS instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScalingInstance' => [ + 'description' => 'Details of the ECS instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the ECS instance was added to the scaling group. The value is accurate to minutes.'."\n", + 'type' => 'string', + 'example' => '2020-05-18T03:11Z', + ], + 'LoadBalancerWeight' => [ + 'description' => 'The weight of the ECS instance as a backend server of the associated CLB instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'LaunchTemplateId' => [ + 'description' => 'The ID of the launch template.'."\n", + 'type' => 'string', + 'example' => 'lt-m5e3ofjr1zn1aw7****', + ], + 'InstanceId' => [ + 'description' => 'The ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp109k5j3dum1ce6****', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding policy for the preemptible instance. Valid values:'."\n" + ."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'SpotWithPriceLimit', + ], + 'LaunchTemplateVersion' => [ + 'description' => 'The version number of the launch template.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'HealthStatus' => [ + 'description' => 'The health status of the ECS instance in the scaling group. If the ECS instance does not run as expected, Auto Scaling considers the ECS instance unhealthy. Valid values:'."\n" + ."\n" + .'* Healthy'."\n" + .'* Unhealthy'."\n" + ."\n" + .'Auto Scaling automatically removes unhealthy ECS instances from the scaling group and then releases automatically created instances among the unhealthy instances.'."\n" + ."\n" + .'Unhealthy ECS instances that are manually added to the scaling group are released based on the management mode of the instance lifecycles. If the lifecycles of the ECS instances are not managed by the scaling group, Auto Scaling removes the instances from the scaling group but does not release the instances. If the lifecycles of the ECS instances are managed by the scaling group, Auto Scaling removes the instances from the scaling group and releases the instances.'."\n" + ."\n" + .'> Make sure that you have sufficient balance within your Alibaba Cloud account. If you have overdue payments within your Alibaba Cloud account, pay-as-you-go and preemptible instances are stopped or released. For information about how the states of ECS instances with overdue payments change, see [Overdue payments](~~170589~~).'."\n", + 'type' => 'string', + 'example' => 'Healthy', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group to which the instance belongs.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + 'WarmupState' => [ + 'description' => 'The warmup sate of the ECS instance. Valid values:'."\n" + ."\n" + .'* NoNeedWarmup: The instance does not need to be warmed up.'."\n" + .'* WaitingForInstanceWarmup: The instance is being warmed up.'."\n" + .'* InstanceWarmupFinish: The instance is warmed up.'."\n", + 'type' => 'string', + 'example' => 'NoNeedWarmup', + ], + 'LifecycleState' => [ + 'description' => 'The lifecycle state of the ECS instance in the scaling group. Valid values:'."\n" + ."\n" + .'* InService: The ECS instance is added to the scaling group and provides services as expected.'."\n" + .'* Pending: The ECS instance is being added to the scaling group. During this process, Auto Scaling adds the ECS instance to the backend server groups of the associated CLB instance and adds the private IP address of the ECS instance to the IP address whitelist of the associated ApsaraDB RDS instance.'."\n" + .'* Pending:Wait: The ECS instance is waiting to be added to the scaling group. If a lifecycle hook that applies to scale-out activities is created for the scaling group, the ECS instance enters the Pending:Wait state. The ECS instance is added to the scaling group only after the lifecycle hook times out.'."\n" + .'* Protected: The ECS instance is being protected. The ECS instance can provide services as expected. However, Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage the lifecycle of the ECS instance.'."\n" + .'* Standby: The ECS instance is on standby. The ECS instance is out of service and the weight of the ECS instance as a backend server is set to zero. Auto Scaling does not manage the lifecycle of the ECS instance. You must manually manage the lifecycle of the ECS instance.'."\n" + .'* Stopped: The ECS instance is stopped. The ECS instance is stopped and cannot provide services.'."\n" + .'* Removing: The ECS instance is being removed from the scaling group. During this process, Auto Scaling removes the ECS instance from the backend server groups of the associated CLB instance and removes the IP address of the ECS instance from the IP address whitelist of the associated ApsaraDB RDS instance.'."\n" + .'* Removing:Wait: The ECS instance is waiting to be removed from the scaling group. If a lifecycle hook that applies to scale-in activities is created for the scaling group, the ECS instance enters the Removing:Wait state. The ECS instance is removed from the scaling group only after the lifecycle hook times out.'."\n", + 'type' => 'string', + 'example' => 'InService', + ], + 'CreationType' => [ + 'description' => 'Indicates how the ECS instance is created. Valid values:'."\n" + ."\n" + .'* AutoCreated: The ECS instance is automatically created by Auto Scaling based on the instance configuration source of the scaling group.'."\n" + .'* Attached: The ECS instance is manually added to the scaling group.'."\n", + 'type' => 'string', + 'example' => 'AutoCreated', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'ScalingConfigurationId' => [ + 'description' => 'The ID of the associated scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'asc-bp1i65jd06v04vdh****', + ], + 'Entrusted' => [ + 'description' => 'Indicates whether the lifecycles of the ECS instances that are manually added to the scaling group are managed by the scaling group. If the scaling group manages the lifecycles of the ECS instances that are manually added, Auto Scaling releases the ECS instances after Auto Scaling removes the ECS instances from the scaling group. The release rule does not apply to ECS instances that are manually removed from the scaling group. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'WeightedCapacity' => [ + 'description' => 'The weight of the instance type. The weight indicates the capacity of a single instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'CreatedTime' => [ + 'description' => 'The time when the ECS instance was added to the scaling group. The value is accurate to seconds.'."\n", + 'type' => 'string', + 'example' => '2020-05-18T03:11:39Z', + ], + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity during which the ECS instance was added to the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asa-bp1c9djwrgxjyk31****', + ], + 'InstanceType' => [ + 'description' => 'The type of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.small', + ], + 'ScalingInstanceId' => [ + 'type' => 'string', + ], + 'PrivateIpAddress' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B13527BF-1FBD-4334-A512-20F5E9D3****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalSpotCount\\": 4,\\n \\"TotalCount\\": 1,\\n \\"ScalingInstances\\": {\\n \\"ScalingInstance\\": [\\n {\\n \\"CreationTime\\": \\"2020-05-18T03:11Z\\",\\n \\"LoadBalancerWeight\\": 50,\\n \\"LaunchTemplateId\\": \\"lt-m5e3ofjr1zn1aw7****\\",\\n \\"InstanceId\\": \\"i-bp109k5j3dum1ce6****\\",\\n \\"SpotStrategy\\": \\"SpotWithPriceLimit\\",\\n \\"LaunchTemplateVersion\\": \\"1\\",\\n \\"HealthStatus\\": \\"Healthy\\",\\n \\"ScalingGroupId\\": \\"asg-bp1igpak5ft1flyp****\\",\\n \\"WarmupState\\": \\"NoNeedWarmup\\",\\n \\"LifecycleState\\": \\"InService\\",\\n \\"CreationType\\": \\"AutoCreated\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"ScalingConfigurationId\\": \\"asc-bp1i65jd06v04vdh****\\",\\n \\"Entrusted\\": true,\\n \\"WeightedCapacity\\": 4,\\n \\"CreatedTime\\": \\"2020-05-18T03:11:39Z\\",\\n \\"ScalingActivityId\\": \\"asa-bp1c9djwrgxjyk31****\\",\\n \\"InstanceType\\": \\"ecs.n1.small\\",\\n \\"ScalingInstanceId\\": \\"asi-j6cj1gcte640ekhb****\\",\\n \\"PrivateIpAddress\\": \\"1**.2*.1**.2**\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeScalingInstancesResponse>\\n <RequestId>B13527BF-1FBD-4334-A512-20F5E9D3****</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalSpotCount>4</TotalSpotCount>\\n <TotalCount>1</TotalCount>\\n <ScalingInstances>\\n <CreationTime>2020-05-18T03:11Z</CreationTime>\\n <LoadBalancerWeight>50</LoadBalancerWeight>\\n <LaunchTemplateId>lt-m5e3ofjr1zn1aw7****</LaunchTemplateId>\\n <InstanceId>i-bp109k5j3dum1ce6****</InstanceId>\\n <SpotStrategy>SpotWithPriceLimit</SpotStrategy>\\n <LaunchTemplateVersion>1</LaunchTemplateVersion>\\n <HealthStatus>Healthy</HealthStatus>\\n <ScalingGroupId>asg-bp1igpak5ft1flyp****</ScalingGroupId>\\n <WarmupState>NoNeedWarmup</WarmupState>\\n <LifecycleState>InService</LifecycleState>\\n <CreationType>AutoCreated</CreationType>\\n <ZoneId>cn-hangzhou-g</ZoneId>\\n <ScalingConfigurationId>asc-bp1i65jd06v04vdh****</ScalingConfigurationId>\\n <Entrusted>true</Entrusted>\\n <WeightedCapacity>4</WeightedCapacity>\\n <CreatedTime>2020-05-18T03:11:39Z</CreatedTime>\\n <ScalingActivityId>asa-bp1c9djwrgxjyk31****</ScalingActivityId>\\n <InstanceType>ecs.n1.small</InstanceType>\\n <ScalingInstanceId>asi-j6cj1gcte640ekhb****</ScalingInstanceId>\\n <PrivateIpAddress>1**.2*.1**.2**</PrivateIpAddress>\\n </ScalingInstances>\\n</DescribeScalingInstancesResponse>","errorExample":""}]', + 'title' => 'DescribeScalingInstances', + 'description' => '## Description'."\n" + ."\n" + .'You can query ECS instances by scaling group ID, scaling configuration ID, health status, state, and instance creation method.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeScalingActivities' => [ + 'summary' => '查询伸缩活动', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92680', + 'abilityTreeNodes' => [ + 'FEATUREessACRSW1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group to which the scaling activity that you want to query belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n" + ."\n" + .'> When you call this operation, you must specify a value for the `ScalingGroupId` or `ScalingActivityId.N` parameter. Otherwise, an error is reported when you call this operation.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'StatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the scaling activity. Valid values:'."\n" + ."\n" + .'* Successful: The scaling activity is successful.'."\n" + .'* Warning: The scaling activity is partially successful.'."\n" + .'* Failed: The scaling activity failed.'."\n" + .'* InProgress: The scaling activity is in progress.'."\n" + .'* Rejected: The request to trigger the scaling activity is rejected.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Successful', + ], + ], + [ + 'name' => 'ScalingActivityId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the scaling activity.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of scaling activity N that you want to query.'."\n" + ."\n" + .'> When you call this operation, you must specify a value for the `ScalingGroupId` or `ScalingActivityId.N` parameter. Otherwise, an error is reported when you call this operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asa-bp161xudmuxdzofe****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceRefreshTaskId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CC107349-57B7-4405-B1BF-9BF5AF7F****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of scaling activities.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingActivities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScalingActivity' => [ + 'description' => 'Details of the scaling activities.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Progress' => [ + 'description' => 'The execution progress of the scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ScalingInstanceNumber' => [ + 'description' => '* If the scaling activity is a scale-out activity, the value of this parameter indicates the number of instances that were scaled out or the number of instances that were started from Economical Mode during the scaling activity.'."\n" + .'* If the scaling activity is a scale-in activity, the value of this parameter indicates the number of instances that were scaled in or the number of instances that were stopped in Economical Mode during the scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AttachedCapacity' => [ + 'description' => 'The total number of instances that were manually added to the scaling group after the scaling activity was complete.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TotalCapacity' => [ + 'description' => 'The total number of instances in the scaling group after the scaling activity was complete.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + 'AutoCreatedCapacity' => [ + 'description' => 'The total number of instances that were automatically created by Auto Scaling after the scaling activity was complete.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'EndTime' => [ + 'description' => 'The time when the scaling activity was complete.'."\n", + 'type' => 'string', + 'example' => '2020-09-10T09:54Z', + ], + 'StartTime' => [ + 'description' => 'The time when the scaling activity started.'."\n", + 'type' => 'string', + 'example' => '2020-09-10T09:54Z', + ], + 'Description' => [ + 'description' => 'The description of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'Add \\"1\\" ECS instance', + ], + 'StatusCode' => [ + 'description' => 'The status of the scaling activity. Valid values:'."\n" + ."\n" + .'* Successful: The scaling activity is successful.'."\n" + .'* Warning: The scaling activity is partially successful.'."\n" + .'* Failed: The scaling activity failed.'."\n" + .'* InProgress: The scaling activity is in progress.'."\n" + .'* Rejected: The request to trigger the scaling activity is rejected.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'Cause' => [ + 'description' => 'The reason why the scaling activity was triggered.'."\n", + 'type' => 'string', + 'example' => 'A user requests to execute scaling rule \\"asr-bp12tcnol686y1ik****\\", changing the Total Capacity from \\"1\\" to \\"2\\".', + ], + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp161xudmuxdzofe****', + ], + 'StatusMessage' => [ + 'description' => 'The status information about the scaling activity.'."\n", + 'type' => 'string', + 'example' => '\\"1\\" ECS instances are added', + ], + 'CreatedCapacity' => [ + 'description' => 'The number of instances that were created during the scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DestroyedCapacity' => [ + 'description' => 'The number of instances that were released during the scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StartedCapacity' => [ + 'description' => 'The number of instances that were started from Economical Mode during the scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StoppedCapacity' => [ + 'description' => 'The number of instances that were stopped in Economical Mode during the scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreatedInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CreatedInstance' => [ + 'description' => 'The instances that were created during the scaling activity.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instances that were created during the scaling activity.', + 'type' => 'string', + 'example' => '["i-abc1","i-abc2"]', + ], + ], + ], + ], + 'DestroyedInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DestroyedInstance' => [ + 'description' => 'The instances that were released during the scaling activity.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instances that were released during the scaling activity.', + 'type' => 'string', + 'example' => '[ "i-abc1", "i-abc2" ]', + ], + ], + ], + ], + 'StartedInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StartedInstance' => [ + 'description' => 'The instances that were started from Economical Mode during the scaling activity.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instances that were started from Economical Mode during the scaling activity.', + 'type' => 'string', + 'example' => '[ "i-abc1", "i-abc2" ]', + ], + ], + ], + ], + 'StoppedInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StoppedInstance' => [ + 'description' => 'The instances that were stopped in Economical Mode during the scaling activity.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instances that were stopped in Economical Mode during the scaling activity.', + 'type' => 'string', + 'example' => '[ "i-abc1", "i-abc2" ]', + ], + ], + ], + ], + 'ErrorCode' => [ + 'description' => 'The error code that is returned when the scaling activity fails.'."\n", + 'type' => 'string', + 'example' => 'OperationDenied.NoStock', + ], + 'ErrorMessage' => [ + 'description' => 'The error message that is returned when the scaling activity fails.'."\n", + 'type' => 'string', + 'example' => 'The specified ECS resource is out of stock in this region. Please try again later.', + ], + 'Detail' => [ + 'description' => 'Details of the scaling activity.'."\n", + 'type' => 'string', + 'example' => '"new ECS instances "i-j6c8ilerw, i-j6c8iler4mx" are created."', + ], + 'TriggerSourceType' => [ + 'type' => 'string', + ], + 'TriggerSourceId' => [ + 'type' => 'string', + ], + 'LifecycleHookContext' => [ + 'type' => 'object', + 'properties' => [ + 'DisableLifecycleHook' => [ + 'type' => 'boolean', + ], + 'IgnoredLifecycleHookIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IgnoredLifecycleHookId' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ActivityMetadata' => [ + 'type' => 'string', + ], + 'InstanceRefreshTaskId' => [ + 'type' => 'string', + ], + 'ErrorMessages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorMessages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'FailedInstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FailedInstanceIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CC107349-57B7-4405-B1BF-9BF5AF7F****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"ScalingActivities\\": {\\n \\"ScalingActivity\\": [\\n {\\n \\"Progress\\": 100,\\n \\"ScalingInstanceNumber\\": 1,\\n \\"AttachedCapacity\\": \\"0\\",\\n \\"TotalCapacity\\": \\"2\\",\\n \\"ScalingGroupId\\": \\"asg-bp18p2yfxow2dloq****\\",\\n \\"AutoCreatedCapacity\\": \\"2\\",\\n \\"EndTime\\": \\"2020-09-10T09:54Z\\",\\n \\"StartTime\\": \\"2020-09-10T09:54Z\\",\\n \\"Description\\": \\"Add \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\" ECS instance\\",\\n \\"StatusCode\\": \\"Successful\\",\\n \\"Cause\\": \\"A user requests to execute scaling rule \\\\\\\\\\\\\\"asr-bp12tcnol686y1ik****\\\\\\\\\\\\\\", changing the Total Capacity from \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\" to \\\\\\\\\\\\\\"2\\\\\\\\\\\\\\".\\",\\n \\"ScalingActivityId\\": \\"asa-bp161xudmuxdzofe****\\",\\n \\"StatusMessage\\": \\"\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\" ECS instances are added\\",\\n \\"CreatedCapacity\\": 1,\\n \\"DestroyedCapacity\\": 1,\\n \\"StartedCapacity\\": 1,\\n \\"StoppedCapacity\\": 1,\\n \\"CreatedInstances\\": {\\n \\"CreatedInstance\\": [\\n \\"[ \\\\\\"i-abc1\\\\\\", \\\\\\"i-abc2\\\\\\" ]\\"\\n ]\\n },\\n \\"DestroyedInstances\\": {\\n \\"DestroyedInstance\\": [\\n \\"[ \\\\\\"i-abc1\\\\\\", \\\\\\"i-abc2\\\\\\" ]\\"\\n ]\\n },\\n \\"StartedInstances\\": {\\n \\"StartedInstance\\": [\\n \\"[ \\\\\\"i-abc1\\\\\\", \\\\\\"i-abc2\\\\\\" ]\\"\\n ]\\n },\\n \\"StoppedInstances\\": {\\n \\"StoppedInstance\\": [\\n \\"[ \\\\\\"i-abc1\\\\\\", \\\\\\"i-abc2\\\\\\" ]\\"\\n ]\\n },\\n \\"ErrorCode\\": \\"OperationDenied.NoStock\\",\\n \\"ErrorMessage\\": \\"The specified ECS resource is out of stock in this region. Please try again later.\\",\\n \\"Detail\\": \\"\\\\\\"new ECS instances \\\\\\"i-j6c8ilerw, i-j6c8iler4mx\\\\\\" are created.\\\\\\"\\",\\n \\"TriggerSourceType\\": \\"Api\\",\\n \\"TriggerSourceId\\": \\"2346366580*****\\",\\n \\"LifecycleHookContext\\": {\\n \\"DisableLifecycleHook\\": false,\\n \\"IgnoredLifecycleHookIds\\": {\\n \\"IgnoredLifecycleHookId\\": [\\n \\"ash-bp14zolna43z266bq***\\"\\n ]\\n }\\n },\\n \\"ActivityMetadata\\": \\"{\\\\\\\\\\\\\\"goatscaler.io/managed\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"}\\",\\n \\"InstanceRefreshTaskId\\": \\"ir-asdf12adsxg*****\\",\\n \\"ErrorMessages\\": {\\n \\"ErrorMessages\\": [\\n {\\n \\"Description\\": \\"Fail to create instances into scaling group.\\",\\n \\"Code\\": \\"OperationDenied.NoStock\\",\\n \\"Message\\": \\"The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.\\",\\n \\"FailedInstanceIds\\": {\\n \\"FailedInstanceIds\\": [\\n \\"i-8vbedazhjj6a6******\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeScalingActivitiesResponse>\\n <RequestId>CC107349-57B7-4405-B1BF-9BF5AF7F****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <ScalingActivities>\\n <Progress>100</Progress>\\n <ScalingInstanceNumber>1</ScalingInstanceNumber>\\n <AttachedCapacity>0</AttachedCapacity>\\n <TotalCapacity>2</TotalCapacity>\\n <ScalingGroupId>asg-bp18p2yfxow2dloq****</ScalingGroupId>\\n <AutoCreatedCapacity>2</AutoCreatedCapacity>\\n <EndTime>2020-09-10T09:54Z</EndTime>\\n <StartTime>2020-09-10T09:54Z</StartTime>\\n <Description>Add \\\\\\"1\\\\\\" ECS instance</Description>\\n <StatusCode>Successful</StatusCode>\\n <Cause>A user requests to execute scaling rule \\\\\\"asr-bp12tcnol686y1ik****\\\\\\", changing the Total Capacity from \\\\\\"1\\\\\\" to \\\\\\"2\\\\\\".</Cause>\\n <ScalingActivityId>asa-bp161xudmuxdzofe****</ScalingActivityId>\\n <StatusMessage>\\\\\\"1\\\\\\" ECS instances are added</StatusMessage>\\n <CreatedCapacity>1</CreatedCapacity>\\n <DestroyedCapacity>1</DestroyedCapacity>\\n <StartedCapacity>1</StartedCapacity>\\n <StoppedCapacity>1</StoppedCapacity>\\n <CreatedInstances>[ \\"i-abc1\\", \\"i-abc2\\" ]</CreatedInstances>\\n <DestroyedInstances>[ \\"i-abc1\\", \\"i-abc2\\" ]</DestroyedInstances>\\n <StartedInstances>[ \\"i-abc1\\", \\"i-abc2\\" ]</StartedInstances>\\n <StoppedInstances>[ \\"i-abc1\\", \\"i-abc2\\" ]</StoppedInstances>\\n <ErrorCode>OperationDenied.NoStock</ErrorCode>\\n <ErrorMessage>The specified ECS resource is out of stock in this region. Please try again later.</ErrorMessage>\\n <Detail>\\"new ECS instances \\"i-j6c8ilerw, i-j6c8iler4mx\\" are created.\\"</Detail>\\n <TriggerSourceType>Api</TriggerSourceType>\\n <TriggerSourceId>2346366580*****</TriggerSourceId>\\n <LifecycleHookContext>\\n <DisableLifecycleHook>false</DisableLifecycleHook>\\n <IgnoredLifecycleHookIds>ash-bp14zolna43z266bq***</IgnoredLifecycleHookIds>\\n </LifecycleHookContext>\\n <ActivityMetadata>{\\\\\\"goatscaler.io/managed\\\\\\":\\\\\\"true\\\\\\"}</ActivityMetadata>\\n <InstanceRefreshTaskId>ir-asdf12adsxg*****</InstanceRefreshTaskId>\\n <ErrorMessages>\\n <Description>Fail to create instances into scaling group.</Description>\\n <Code>OperationDenied.NoStock</Code>\\n <Message>The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.</Message>\\n <FailedInstanceIds>i-8vbedazhjj6a6******</FailedInstanceIds>\\n </ErrorMessages>\\n </ScalingActivities>\\n</DescribeScalingActivitiesResponse>","errorExample":""}]', + 'title' => 'DescribeScalingInstances', + 'description' => '## Description'."\n" + ."\n" + .'* You can specify a scaling group ID to query all scaling activities in the scaling group.'."\n" + .'* You can filter query results based on the status of scaling activities.'."\n" + .'* You can query scaling activities that are executed in the previous 30 days.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeScalingActivityDetail' => [ + 'summary' => '查询一个伸缩活动的详细信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92681', + 'abilityTreeNodes' => [ + 'FEATUREessACRSW1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingActivityId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling activity that you want to query. You can call the [DescribeScalingActivities](~~25961~~) operation to query the IDs of scaling activities.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asa-bp1c9djwrgxjyk31****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B13527BF-1FBD-4334-A512-20F5E9D3FB4D', + ], + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp1c9djwrgxjyk31****', + ], + 'Detail' => [ + 'description' => 'The details about the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'new ECS instances \\"i-bp16t2cgmiiymeqv****\\" are created.', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B13527BF-1FBD-4334-A512-20F5E9D3FB4D\\",\\n \\"ScalingActivityId\\": \\"asa-bp1c9djwrgxjyk31****\\",\\n \\"Detail\\": \\"new ECS instances \\\\\\\\\\\\\\"i-bp16t2cgmiiymeqv****\\\\\\\\\\\\\\" are created.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeScalingActivityDetailResponse>\\n <RequestId>B13527BF-1FBD-4334-A512-20F5E9D3FB4D</RequestId>\\n <ScalingActivityId>asa-bp1c9djwrgxjyk31****</ScalingActivityId>\\n <Detail>new ECS instances \\\\\\"i-bp16t2cgmiiymeqv****\\\\\\" are created.</Detail>\\n</DescribeScalingActivityDetailResponse>","errorExample":""}]', + 'title' => 'DescribeScalingActivityDetail', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeScalingActivityDetail\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeLimitation' => [ + 'summary' => '查询资源配额限制', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92676', + 'abilityTreeNodes' => [ + 'FEATUREessZ1KWHS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MaxNumberOfScheduledTasks' => [ + 'description' => 'The maximum number of scheduled tasks that can be created in a region by using an Alibaba Cloud account.'."\n" + ."\n" + .'> To view the scheduled task quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'MaxNumberOfLoadBalancers' => [ + 'description' => 'The maximum number of Classic Load Balancer (CLB, formerly known as SLB) instances that can be associated with a scaling group.'."\n" + ."\n" + .'> To view the CLB instance quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxNumberOfMaxSize' => [ + 'description' => 'The maximum number of instances that can be contained in a scaling group.'."\n" + ."\n" + .'> To view the instance quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'MaxNumberOfAlbServerGroup' => [ + 'description' => 'The maximum number of Application Load Balancer (ALB) server groups that can be associated with a scaling group.'."\n" + ."\n" + .'> To view the ALB server group quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'MaxNumberOfNlbServerGroup' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaxNumberOfDBInstances' => [ + 'description' => 'The maximum number of ApsaraDB RDS instances that can be associated with a scaling group.'."\n" + ."\n" + .'> To view the ApsaraDB RDS instance quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'MaxNumberOfScalingConfigurations' => [ + 'description' => 'The maximum number of scaling configurations that can be created in a scaling group.'."\n" + ."\n" + .'> To view the scaling configuration quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxNumberOfMinSize' => [ + 'description' => 'The minimum number of instances that must be contained in a scaling group. The value of MaxNumberOfMinSize must be consistent with the value of MaxNumberOfMaxSize.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'MaxNumberOfLifecycleHooks' => [ + 'description' => 'The maximum number of lifecycle hooks that can be created in a scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'MaxNumberOfScalingInstances' => [ + 'description' => 'The maximum number of Elastic Compute Service (ECS) instances or elastic container instances that can be included in each scaling activity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'MaxNumberOfScalingGroups' => [ + 'description' => 'The maximum number of scaling groups that can be created in a region by using an Alibaba Cloud account.'."\n" + ."\n" + .'> To view the scaling group quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BE9BEB41-E7B8-4C7D-A3CF-2DCB106665E9', + ], + 'MaxNumberOfNotificationConfigurations' => [ + 'description' => 'The maximum number of notification rules that can be created in a scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'MaxNumberOfVServerGroups' => [ + 'description' => 'The maximum number of vServer groups that can be specified for a scaling group when a CLB instance is associated with the scaling group.'."\n" + ."\n" + .'> To view the vServer group quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'MaxNumberOfScalingRules' => [ + 'description' => 'The maximum number of scaling rules that can be created for a scaling group.'."\n" + ."\n" + .'> To view the scaling rule quota or manually apply for a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxNumberOfScheduledTasks\\": 70,\\n \\"MaxNumberOfLoadBalancers\\": 30,\\n \\"MaxNumberOfMaxSize\\": 2000,\\n \\"MaxNumberOfAlbServerGroup\\": 30,\\n \\"MaxNumberOfNlbServerGroup\\": 30,\\n \\"MaxNumberOfDBInstances\\": 30,\\n \\"MaxNumberOfScalingConfigurations\\": 70,\\n \\"MaxNumberOfMinSize\\": 2000,\\n \\"MaxNumberOfLifecycleHooks\\": 10,\\n \\"MaxNumberOfScalingInstances\\": 500,\\n \\"MaxNumberOfScalingGroups\\": 200,\\n \\"RequestId\\": \\"BE9BEB41-E7B8-4C7D-A3CF-2DCB1066****\\",\\n \\"MaxNumberOfNotificationConfigurations\\": 6,\\n \\"MaxNumberOfVServerGroups\\": 5,\\n \\"MaxNumberOfScalingRules\\": 70\\n}","errorExample":""},{"type":"xml","example":"<DescribeLimitationResponse>\\n <MaxNumberOfScheduledTasks>70</MaxNumberOfScheduledTasks>\\n <MaxNumberOfLoadBalancers>30</MaxNumberOfLoadBalancers>\\n <MaxNumberOfMaxSize>2000</MaxNumberOfMaxSize>\\n <MaxNumberOfAlbServerGroup>30</MaxNumberOfAlbServerGroup>\\n <MaxNumberOfNlbServerGroup>30</MaxNumberOfNlbServerGroup>\\n <MaxNumberOfDBInstances>30</MaxNumberOfDBInstances>\\n <MaxNumberOfScalingConfigurations>70</MaxNumberOfScalingConfigurations>\\n <MaxNumberOfMinSize>2000</MaxNumberOfMinSize>\\n <MaxNumberOfLifecycleHooks>10</MaxNumberOfLifecycleHooks>\\n <MaxNumberOfScalingInstances>500</MaxNumberOfScalingInstances>\\n <MaxNumberOfScalingGroups>200</MaxNumberOfScalingGroups>\\n <RequestId>BE9BEB41-E7B8-4C7D-A3CF-2DCB1066****</RequestId>\\n <MaxNumberOfNotificationConfigurations>6</MaxNumberOfNotificationConfigurations>\\n <MaxNumberOfVServerGroups>5</MaxNumberOfVServerGroups>\\n <MaxNumberOfScalingRules>70</MaxNumberOfScalingRules>\\n</DescribeLimitationResponse>","errorExample":""}]', + 'title' => 'DescribeLimitation', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeLimitation\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeElasticStrength' => [ + 'summary' => 'DescribeElasticStrength', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232309', + 'abilityTreeNodes' => [ + 'FEATUREess7569XW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'PriorityStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SystemDiskCategories', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ScalingGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'VSwitchIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ImageFamily', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DataDiskCategories', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Ipv6AddressCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '73469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'TotalStrength' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.5', + ], + 'ElasticStrength' => [ + 'type' => 'string', + ], + 'ResourcePools' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Strength' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + ], + 'InstanceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs.c7t.xlarge', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'VSwitchIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2ze0uc933kantv******', + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InstanceTypesOrDiskTypesNotSupported', + ], + 'Msg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The instanceTypes or diskTypes are not supported.', + ], + 'Status' => [ + 'type' => 'string', + ], + 'InventoryHealth' => [ + 'type' => 'object', + 'properties' => [ + 'HealthScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AdequacyScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SupplyScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'HotScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + 'ElasticStrengthModels' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'asg-wz98mnj7nblv9gc****', + ], + 'ElasticStrength' => [ + 'type' => 'string', + ], + 'TotalStrength' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + ], + 'ResourcePools' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs.r7.large', + ], + 'Strength' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.6', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'VSwitchIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-2ze6e8p4aid08lymlsguv', + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InstanceTypesOrDiskTypesNotSupported', + ], + 'Msg' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The instanceTypes or diskTypes are not supported.', + ], + 'Status' => [ + 'type' => 'string', + ], + 'InventoryHealth' => [ + 'type' => 'object', + 'properties' => [ + 'HealthScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AdequacyScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SupplyScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'HotScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"TotalStrength\\": 1.5,\\n \\"ElasticStrength\\": \\"Strong\\",\\n \\"ResourcePools\\": [\\n {\\n \\"Strength\\": 0.6,\\n \\"InstanceType\\": \\"ecs.c7t.xlarge\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-2ze0uc933kantv******\\"\\n ],\\n \\"Code\\": \\"InstanceTypesOrDiskTypesNotSupported\\",\\n \\"Msg\\": \\"The instanceTypes or diskTypes are not supported.\\",\\n \\"Status\\": \\"Available\\",\\n \\"InventoryHealth\\": {\\n \\"HealthScore\\": 3,\\n \\"AdequacyScore\\": 3,\\n \\"SupplyScore\\": 3,\\n \\"HotScore\\": 3\\n }\\n }\\n ],\\n \\"ElasticStrengthModels\\": [\\n {\\n \\"ScalingGroupId\\": \\"asg-wz98mnj7nblv9gc****\\",\\n \\"ElasticStrength\\": \\"Strong\\",\\n \\"TotalStrength\\": 5,\\n \\"ResourcePools\\": [\\n {\\n \\"InstanceType\\": \\"ecs.r7.large\\",\\n \\"Strength\\": 0.6,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-2ze6e8p4aid08lymlsguv\\"\\n ],\\n \\"Code\\": \\"InstanceTypesOrDiskTypesNotSupported\\",\\n \\"Msg\\": \\"The instanceTypes or diskTypes are not supported.\\",\\n \\"Status\\": \\"Available\\",\\n \\"InventoryHealth\\": {\\n \\"HealthScore\\": 3,\\n \\"AdequacyScore\\": 3,\\n \\"SupplyScore\\": 2,\\n \\"HotScore\\": 0\\n }\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeElasticStrengthResponse>\\n <RequestId>73469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <TotalStrength>1.5</TotalStrength>\\n <ElasticStrength>Strong</ElasticStrength>\\n <ResourcePools>\\n <Strength>0.6</Strength>\\n <InstanceType>ecs.c7t.xlarge</InstanceType>\\n <ZoneId>cn-hangzhou-g</ZoneId>\\n <VSwitchIds>vsw-2ze0uc933kantv******</VSwitchIds>\\n <Code>InstanceTypesOrDiskTypesNotSupported</Code>\\n <Msg>The instanceTypes or diskTypes are not supported.</Msg>\\n <Status>Available</Status>\\n <InventoryHealth>\\n <HealthScore>3</HealthScore>\\n <AdequacyScore>3</AdequacyScore>\\n <SupplyScore>3</SupplyScore>\\n <HotScore>3</HotScore>\\n </InventoryHealth>\\n </ResourcePools>\\n <ElasticStrengthModels>\\n <ScalingGroupId>asg-wz98mnj7nblv9gc****</ScalingGroupId>\\n <ElasticStrength>Strong</ElasticStrength>\\n <TotalStrength>5</TotalStrength>\\n <ResourcePools>\\n <InstanceType>ecs.r7.large</InstanceType>\\n <Strength>0.6</Strength>\\n <ZoneId>cn-hangzhou-g</ZoneId>\\n <VSwitchIds>vsw-2ze6e8p4aid08lymlsguv</VSwitchIds>\\n <Code>InstanceTypesOrDiskTypesNotSupported</Code>\\n <Msg>The instanceTypes or diskTypes are not supported.</Msg>\\n <Status>Available</Status>\\n <InventoryHealth>\\n <HealthScore>3</HealthScore>\\n <AdequacyScore>3</AdequacyScore>\\n <SupplyScore>2</SupplyScore>\\n <HotScore>0</HotScore>\\n </InventoryHealth>\\n </ResourcePools>\\n </ElasticStrengthModels>\\n</DescribeElasticStrengthResponse>","errorExample":""}]', + ], + 'VerifyAuthentication' => [ + 'summary' => '检测是否已授权弹性伸缩操作ECS和ECI资源', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92723', + 'abilityTreeNodes' => [ + 'FEATUREessZ1KWHS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of your Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + ], + ], + [ + 'name' => 'OnlyCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to only check the authorization status. Valid values:'."\n" + ."\n" + .'* true: only checks the authorization status and does not create the service-linked role.'."\n" + .'* false: checks the authorization status and automatically creates the service-linked role if Auto Scaling is not authorized to manage ECS resources.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'INNER_euumyufYKqwc8ywxPcP****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'UserNotAuthorizeEss', + 'errorMessage' => 'Ess should be authorized in ram to operate user ecs resource.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<VerifyAuthenticationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</VerifyAuthenticationResponse>","errorExample":""}]', + 'title' => 'VerifyAuthentication', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=VerifyAuthentication\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SuspendProcesses' => [ + 'summary' => '暂停伸缩组中的指定流程', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92720', + 'abilityTreeNodes' => [ + 'FEATUREess4ZDI6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp15oubotmrq11xe****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n" + ."\n" + .'The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Process', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The number of processes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Process N that you want to suspend. Valid values of N: 1 to 100. Valid values:'."\n" + ."\n" + .'* ScaleIn'."\n" + .'* ScaleOut'."\n" + .'* HealthCheck'."\n" + .'* AlarmNotification'."\n" + .'* ScheduledAction'."\n" + ."\n" + .'You can suspend five types of processes. If you specify more than five types, the duplicate types are automatically removed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ScaleIn', + ], + 'required' => true, + 'example' => 'ScaleIn', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3E2033F0-03B4-419D-BCE2-C2339DB51B30', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E2033F0-03B4-419D-BCE2-C2339DB5****\\"\\n}","errorExample":""},{"type":"xml","example":"<SuspendProcessesResponse>\\n <RequestId>3E2033F0-03B4-419D-BCE2-C2339DB5****</RequestId>\\n</SuspendProcessesResponse>","errorExample":""}]', + 'title' => 'SuspendProcesses', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=SuspendProcesses\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ResumeProcesses' => [ + 'summary' => '恢复伸缩组中被暂停的流程', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92715', + 'abilityTreeNodes' => [ + 'FEATUREess4ZDI6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp15oubotmrq11xe****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Process', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The number of processes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of process N that you want to resume. Valid values of N: 1 to 100.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ScaleIn'."\n" + .'* ScaleOut'."\n" + .'* HealthCheck'."\n" + .'* AlarmNotification'."\n" + .'* ScheduledAction'."\n" + ."\n" + .'You can resume the preceding types of scaling processes. If you specify more than five types, the system removes the duplicate types.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ScaleIn', + ], + 'required' => true, + 'example' => 'ScaleIn', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E38EB733-D714-4658-8A5F-0688AB680414', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E38EB733-D714-4658-8A5F-0688AB68****\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeProcessesResponse>\\n <RequestId>E38EB733-D714-4658-8A5F-0688AB68****</RequestId>\\n</ResumeProcessesResponse>","errorExample":""}]', + 'title' => 'ResumeProcesses', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=ResumeProcesses\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'VerifyUser' => [ + 'summary' => '验证是否已开通弹性伸缩服务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92724', + 'abilityTreeNodes' => [ + 'FEATUREessZ1KWHS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<VerifyUserResponse></VerifyUserResponse>","errorExample":""}]', + 'title' => 'VerifyUser', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=VerifyUser\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CreateScalingConfiguration' => [ + 'summary' => '创建伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92657', + 'abilityTreeNodes' => [ + 'FEATUREessWJGIW5', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group in which you want to create the scaling configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the image that is used by Auto Scaling to create instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos6u5_64_20G_aliaegis****.vhd', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image. The name must be unique in a region. If you specify the **ImageId **parameter, the **ImageName **parameter is ignored.'."\n" + ."\n" + .'You cannot use the **ImageName **parameter to specify Alibaba Cloud Marketplace images.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'image****', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the ECS instance. For more information, see [Instance family](~~25378~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of vCPUs.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set the **Cpu **parameter to 2 and the **Memory** parameter to 16 to specify the instance types that have 2 vCPUs and 16 GiB of memory. If you specify the **Cpu **and **Memory **parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.'."\n" + ."\n" + .'> You can specify CPU and memory specifications to determine the range of instance types only if the **Scaling ****Policy **parameter is set to **Cost ****Optimization Policy** and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the memory.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set the **Cpu **parameter to 2 and the **Memory **parameter to 16 to specify the instance types that have 2 vCPUs and 16 GiB of memory. If you specify the **Cpu **and **Memory **parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.'."\n" + ."\n" + .'> You can specify CPU and memory specifications to determine the range of instance types only if the **Scaling Policy** parameter is set to **Cost Optimization Policy** and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the deployment set to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pz****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group with which the ECS instance is associated. The ECS instances that are associated with the same security group can access each other.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-280ih****', + ], + ], + [ + 'name' => 'IoOptimized', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to create an I/O optimized instance. Valid values:'."\n" + ."\n" + .'* none: does not create an I/O optimized instance.'."\n" + .'* optimized: creates an I/O optimized instance.'."\n" + ."\n" + .'For instances of retired instance types, the default value is none. For instances of other instance types, the default value is optimized. For information about the retired instance types, see [Retired instance types](~~55263~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'optimized', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method for network usage. Valid values:'."\n" + ."\n" + .'* PayByBandwidth: You are charged for the maximum available bandwidth that is specified by the **InternetMaxBandwidthOut **parameter.'."\n" + .'* PayByTraffic: You are charged for the actual traffic that is used. **InternetMaxBandwidthOut **specifies only the maximum available bandwidth.'."\n" + ."\n" + .'Default value for the classic network: PayByBandwidth. Default value for VPCs: PayByTraffic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + ], + ], + [ + 'name' => 'InternetMaxBandwidthIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: 1 to 200.'."\n" + ."\n" + .'Default value: 200. This parameter is not used for billing because inbound traffic to instances is free of charge.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'InternetMaxBandwidthOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum outbound public bandwidth. Unit: Mbit/s.'."\n" + ."\n" + .'* Valid values if you set the **InternetChargeType **parameter to **PayByBandwidth**: 0 to 100. If this parameter is not specified, 0 is used as the value of this parameter.'."\n" + .'* Valid values if you set the **InternetChargeType **parameter to **PayByTraffic**: 0 to 100. If this parameter is not specified, an error is reported.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'SystemDisk.Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the system disk. Valid values:'."\n" + ."\n" + .'* cloud: basic disk'."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* ephemeral_ssd: local standard SSD'."\n" + .'* cloud_essd: enhanced SSD (ESSD)'."\n" + .'* cloud_auto: ESSD AutoPL disk'."\n" + ."\n" + .'You cannot specify the **SystemDisk.Category** and `SystemDiskCategories.N` parameters at the same time. If you do not specify the **SystemDisk.Category** and `SystemDiskCategories.N` parameters, the default value of **SystemDisk.Category** is used. For non-I/O optimized instances of Generation I instance types, the default value is cloud. For instances of other instance types, the default value is cloud_efficiency.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDisk.Size', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the system disk. Unit: GiB. Valid values: 20 to 500.'."\n" + ."\n" + .'The value of **SystemDisk.Size** must be greater than or equal to max{20, ImageSize}.'."\n" + ."\n" + .'Default value: max{40, ImageSize}.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'SystemDisk.DiskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the system disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssdSystem', + ], + ], + [ + 'name' => 'SystemDisk.Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the system disk. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test system disk.', + ], + ], + [ + 'name' => 'SystemDisk.AutoSnapshotPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the automatic snapshot policy that you want to apply to the system disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sp-bp12m37ccmxvbmi5****', + ], + ], + [ + 'name' => 'SystemDisk.PerformanceLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance level (PL) of the system disk of the ESSD category. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL0.'."\n" + ."\n" + .'> For more information about how to select ESSD PLs, see [ESSDs](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'ScalingConfigurationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n" + ."\n" + .'The name of the scaling configuration must be unique in a scaling group in a region. If you do not specify this parameter, the value of **ScalingConfigurationId** is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalingconfig****', + ], + ], + [ + 'name' => 'LoadBalancerWeight', + 'in' => 'query', + 'schema' => [ + 'description' => 'The weight of the ECS instance as a backend server of the associated Server Load Balancer (SLB) instance. Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags of the ECS instance. The tags must be specified in the key-value pair format. You can specify up to 20 tags. Take note of the following items when you specify tag keys and tag values:'."\n" + ."\n" + .'* A tag key can be up to 64 characters in length. The key cannot start with acs: or aliyun and cannot contain `http://` or `https://`. You cannot specify an empty string as a tag key.'."\n" + .'* A tag value can be up to 128 characters in length. The value cannot start with acs: or aliyun and cannot contain `http://` or `https://`. You can specify an empty string as a tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key1":"value1","key2":"value2", ... "key5":"value5"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user data of the ECS instance. The data must be encoded in Base64. The maximum size of the data before encoding is 16 KB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'echo hello ecs!', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the key pair that is used to log on to the ECS instance.'."\n" + ."\n" + .'* Windows instances do not use this parameter.'."\n" + .'* By default, the username and password authentication method is disabled for Linux instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'KeyPairTest', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role that is associated with the ECS instance. The name is provided and maintained by Resource Access Management (RAM). You can call the [ListRoles](~~28713~~) operation to query the available RAM roles. You can call the [CreateRole](~~28710~~) operation to create RAM roles.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ramrole****', + ], + ], + [ + 'name' => 'SecurityEnhancementStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable security hardening. Valid values:'."\n" + ."\n" + .'* Active: enables security hardening. This value is valid only for public images.'."\n" + .'* Deactive: disables security hardening. This value is valid for all image types.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the ECS instance that is automatically created based on the scaling configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance****', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname of the ECS instance. The hostname cannot start or end with a period (.) or a hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-). Naming conventions for different types of instances:'."\n" + ."\n" + .'* Windows instances: The hostname must be 2 to 15 characters in length, and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.) or contain only digits.'."\n" + .'* Other instances such as Linux instances: The hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'host****', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy that you want to apply to pay-as-you-go instances and preemptible instances. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is a preemptible instance that has a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'PasswordInherit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use the password that is preconfigured in the image. Before you use this parameter, make sure that a password is configured for the image. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that is used to log on to the ECS instance. The password must be 8 to 30 characters in length, and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:'."\n" + ."\n" + .' ()` ~!@#$%^&*-_+=\\|{}[]:;\'<>,.?/'."\n" + ."\n" + .'The password of a Windows instance cannot start with a forward slash (/).'."\n" + ."\n" + .'> If you specify the **Password **parameter, we recommend that you use HTTPS to send requests for security purposes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123abc****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-resource****', + ], + ], + [ + 'name' => 'HpcClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Elastic High Performance Computing (E-HPC) cluster to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hpc-clusterid', + ], + ], + [ + 'name' => 'InstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the ECS instance. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test instance.', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Ipv6AddressCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of randomly generated IPv6 addresses that you want to allocate to the elastic network interface (ENI).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CreditSpecification', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance mode of the burstable instance. Valid values:'."\n" + ."\n" + .'* Standard: standard mode'."\n" + .'* Unlimited: unlimited mode'."\n" + ."\n" + .'For more information, see the "Performance modes" section in the [Overview](~~59977~~) topic.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'ImageFamily', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image family. If you specify this parameter, the latest custom images that are available in the specified image family are returned. You can use the images to create instances. If you specify the **ImageId **parameter, you cannot specify the **ImageFamily** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou-daily-update', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone where the ECS instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dedicated host on which the ECS instance runs. You cannot create preemptible instances on dedicated hosts. Therefore, if you configure the **DedicatedHostId **parameter, the **SpotStrategy **and **SpotPriceLimit** parameters are ignored.'."\n" + ."\n" + .'You can call the [DescribeDedicatedHosts](~~134242~~) operation to query the IDs of dedicated hosts.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dh-bp67acfmxazb4p****', + ], + ], + [ + 'name' => 'Affinity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to associate the instance on a dedicated host with the dedicated host. Valid values:'."\n" + ."\n" + .'* default: does not associate the instance with the dedicated host. If you start an instance that was stopped in economical mode and the original dedicated host has insufficient resources, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool.'."\n" + .'* host: associates the instance with the dedicated host. If you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the instance fails to start.'."\n" + ."\n" + .'Default value: default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Tenancy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to create the instance on a dedicated host. Valid values:'."\n" + ."\n" + .'* default: does not create the instance on a dedicated host.'."\n" + .'* host: creates the instance on a dedicated host. If you do not specify the **DedicatedHostId** parameter, the system selects a dedicated host for the instance that you want to create.'."\n" + ."\n" + .'Default value: default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SchedulerOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The scheduling options.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '["testManagedPrivateSpaceId****"]', + ], + ], + [ + 'name' => 'PrivatePoolOptions.MatchCriteria', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the private pool that you want to use to create instances. A private pool is generated when an elasticity assurance or a capacity reservation takes effect. You can select a private pool when you create instances. Valid values:'."\n" + ."\n" + .'* Open: open private pool. The system selects a matching open private pool to create instances. If no matching open private pools are found, the resources in the public pool are used. In this case, you do not need to specify the **PrivatePoolOptions.Id **parameter.'."\n" + .'* Target: specified private pool. The system uses the capacity of a specified private pool to create instances. If the specified private pool is unavailable, no instances can be created. If you set this parameter to **Target**, you must specify the **PrivatePoolOptions.Id** parameter.'."\n" + .'* None: no private pool. The capacity of private pools is not used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Open', + ], + ], + [ + 'name' => 'PrivatePoolOptions.Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the private pool. The ID of a private pool is the same as the ID of the elasticity assurance or capacity reservation for which the private pool is generated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eap-bp67acfmxazb4****', + ], + ], + [ + 'name' => 'SpotDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.'."\n" + ."\n" + .'* The following retention periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket.'."\n" + .'* If you set this parameter to 0, no retention period is specified for the preemptible instance.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SpotInterruptionBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interruption mode of the preemptible instance. Default value: Terminate. Set the value to Terminate, which specifies to release the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Terminate', + ], + ], + [ + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Instance type N. If you specify this parameter, the **InstanceType** parameter is ignored. You can specify up to 10 instance types in a scaling configuration. Valid values of N: 1 to 10.'."\n" + ."\n" + .'A smaller value of N specifies a higher priority. Auto Scaling creates instances based on the priorities of the instance types. If Auto Scaling cannot create instances of the instance type that has the highest priority, Auto Scaling creates instances of the instance type that has the next highest priority.', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance type N. If you specify this parameter, the **InstanceType** parameter is ignored. You can specify up to 10 instance types in a scaling configuration. Valid values of N: 1 to 10.'."\n" + ."\n" + .'A smaller value of N specifies a higher priority. Auto Scaling creates instances based on the priorities of the instance types. If Auto Scaling cannot create instances of the instance type that has the highest priority, Auto Scaling creates instances of the instance type that has the next highest priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + 'required' => false, + 'example' => 'ecs.g6.large', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceTypeOverride', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance type overrides.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'If you want to specify the capacity of instance types in the scaling configuration, you must specify the **InstanceTypeOverride.N.InstanceType **and **InstanceTypeOverride.N.WeightedCapacity **parameters.'."\n" + ."\n" + .'This parameter is used to specify the instance type. You can specify multiple instance types. The **InstanceTypeOverride.N.WeightedCapacity** parameter is used to specify weights for instance types. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> If you specify this parameter, you cannot specify the **InstanceTypes.N** or **InstanceType** parameter.'."\n" + ."\n" + .'For information about the valid values of **InstanceType** in **InstanceTypeOverride.N.InstanceType**, see [Instance family](~~25378~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c5.xlarge', + ], + 'WeightedCapacity' => [ + 'description' => 'If you want to specify the capacity of instance types in the scaling configuration, you must specify the **InstanceTypeOverride.N.InstanceType** and **InstanceTypeOverride.N.WeightedCapacity** parameters. The values of *N* in the two parameters must be the same.'."\n" + ."\n" + .'This parameter specifies the weight of the instance type. The weight specifies the capacity of an instance of the specified instance type in the scaling group. A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity.'."\n" + ."\n" + .'Performance metrics such as the number of vCPUs and the memory size of each instance type may vary. You can specify different weights for different instance types based on your business requirements.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* Current capacity: 0'."\n" + .'* Expected capacity: 6'."\n" + .'* Capacity of ecs.c5.xlarge: 4'."\n" + ."\n" + .'To meet the expected capacity, Auto Scaling must create two ecs.c5.xlarge instances.'."\n" + ."\n" + .'> The capacity of the scaling group cannot exceed the sum of the maximum capacity that is specified by the **MaxSize** parameter and the maximum weight of the instance type.'."\n" + ."\n" + .'Valid values of **WeightedCapacity** in the **InstanceTypeOverride.N.WeightedCapacity **parameter: 1 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'DataDisk', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data disks.'."\n", + 'type' => 'object', + 'properties' => [ + 'PerformanceLevel' => [ + 'description' => 'The PL of data disk *N* that is of the ESSD category. If you set the **DataDisk.N.Category** parameter to **cloud_essd**, the *N* value must be the same as the *N* value in **DataDisk.N.Category**. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'> For more information about how to select ESSD PLs, see [ESSDs](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => 'The ID of the automatic snapshot policy that you want to apply to data disk *N*. Valid values of *N*: 1 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sp-bp19nq9enxqkomib****', + ], + 'Encrypted' => [ + 'description' => 'Specifies whether to encrypt data disk *N.* Valid values of *N*: 1 to 16. Valid values:'."\n" + ."\n" + .'* true: encrypts data disk *N*.'."\n" + .'* false: does not encrypt data disk *N*.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'Description' => [ + 'description' => 'The description of data disk *N*. Valid values of *N*: 1 to 16. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test data disk.', + ], + 'SnapshotId' => [ + 'description' => 'The ID of the snapshot that you want to use to create data disk *N*. Valid values of *N*: 1 to 16. If you specify this parameter, the **DataDisk.N.Size** parameter is ignored. The size of the disk is the same as the size of the specified snapshot.'."\n" + ."\n" + .'If you specify a snapshot created on or before July 15, 2013, the operation fails and the system returns **InvalidSnapshot.TooOld**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 's-280s7****', + ], + 'Categories' => [ + 'description' => 'Category *N* of data disk *N*. The first *N* in **DataDisk.N.Categories.N** represents the serial number of the data disk. Valid values of *N*: 1 to 16. The second *N* in **DataDisk.N.Categories.N** represents the serial number of the data disk category. Valid values of *N*: 1 to 4. You can specify up to four data disk categories in a scaling configuration. A smaller value of *N* specifies a higher priority. If Auto Scaling cannot create instances by using the data disk that has the highest priority, Auto Scaling creates instances by using the data disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. The **DeleteWithInstance** attribute of a basic disk that is created together with the instance is set to **true**.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + ."\n" + .'> You cannot specify the **DataDisk.N.Categories.N **and `DataDisk.N.Category` parameters at the same time.', + 'type' => 'array', + 'items' => [ + 'description' => 'Category *N* of data disk *N*. The first *N* in **DataDisk.N.Categories.N** represents the serial number of the data disk. Valid values of *N*: 1 to 16. The second *N* in **DataDisk.N.Categories.N** represents the serial number of the data disk category. Valid values of *N*: 1 to 4. You can specify up to four data disk categories in a scaling configuration. A smaller value of *N* specifies a higher priority. If Auto Scaling cannot create instances by using the data disk that has the highest priority, Auto Scaling creates instances by using the data disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. The **DeleteWithInstance** attribute of a basic disk that is created together with the instance is set to **true**.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + ."\n" + .'> You cannot specify the **DataDisk.N.Categories.N **and `DataDisk.N.Category` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud', + ], + 'required' => false, + 'example' => 'cloud', + 'maxItems' => 10, + ], + 'Size' => [ + 'description' => 'The size of data disk *N*. Unit: GiB. Valid values of *N*: 1 to 16.'."\n" + ."\n" + .'* Valid values if you set the **DataDisk.N.Category** parameter to **cloud**: 5 to 2000.'."\n" + .'* Valid values if you set the **DataDisk.N.Category** parameter to **cloud_efficiency**: 20 to 32768.'."\n" + .'* Valid values if you set the **DataDisk.N.Category** parameter to **cloud_ssd**: 20 to 32768.'."\n" + .'* Valid values if you set the **DataDisk.N.Category** parameter to **cloud_essd**: 20 to 32768.'."\n" + .'* Valid values if you set the **DataDisk.N.Category** parameter to **ephemeral_ssd**: 5 to 800.'."\n" + ."\n" + .'The value of the **DataDisk.N.Size** parameter must be greater than or equal to the size of the snapshot that is specified by the **SnapshotId** parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Device' => [ + 'description' => 'The mount target of data disk *N*. Valid values of *N*: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when you create the ECS instance. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/dev/xvdb', + ], + 'DiskName' => [ + 'description' => 'The name of data disk *N*. Valid values of *N*: 1 to 16. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssdData', + ], + 'Category' => [ + 'description' => 'The category of data disk *N*. Valid values of *N*: 1 to 16. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. The **DeleteWithInstance** attribute of a basic disk that is created together with the instance is set to **true**.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* ephemeral_ssd: local standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + .'* cloud_auto: ESSD AutoPL disk.'."\n" + ."\n" + .'You cannot specify the **DataDisk.N.Category** and `DataDisk.N.Categories.N` parameters at the same time. If you do not specify the **DataDisk.N.Category** and `DataDisk.N.Categories.N` parameters, the default value of **DataDisk.N.Category** is:'."\n" + ."\n" + .'* cloud_efficiency for I/O optimized instances.'."\n" + .'* cloud for non-I/O optimized instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + 'DeleteWithInstance' => [ + 'description' => 'Specifies whether to release data disk *N* when the instance to which data disk *N* is attached is released. Valid values of *N*: 1 to 16. Valid values:'."\n" + ."\n" + .'* true: releases data disk *N* when the instance is released.'."\n" + .'* false: retains data disk *N* when the instance is released.'."\n" + ."\n" + .'This parameter is available only for independent disks whose **DataDisk.N.Category** parameter is set to **cloud**, **cloud_efficiency**, **cloud_ssd**, **cloud_essd**, or **cloud_auto**. If you specify this parameter for other disks, an error is reported.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'KMSKeyId' => [ + 'description' => 'The ID of the Key Management Service (KMS) key that is used to encrypt data disk *N*. Valid values of *N*: 1 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'ProvisionedIops' => [ + 'description' => 'The preconfigured input/output operations per second (IOPS) for data disk *N*.'."\n" + ."\n" + .'> IOPS measures the number of read and write operations that an Elastic Block Storage (EBS) device can process per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'BurstingEnabled' => [ + 'description' => 'Specifies whether to enable the burst feature for data disk *N*. Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** This parameter is available only if you set the `DataDisk.Category` parameter to `cloud_auto`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The billing information of the preemptible instances.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PriceLimit' => [ + 'description' => 'The price limit of preemptible instance *N*. Valid values of *N*: 1 to 10. This parameter is available only if you set the **SpotStrategy **parameter to **SpotWithPriceLimit**.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'InstanceType' => [ + 'description' => 'The instance type of preemptible instance *N*. Valid values of *N*: 1 to 10. This parameter is available only if you set the **SpotStrategy** parameter to **SpotWithPriceLimit**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'SecurityGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of security group *N* with which you want to associate the ECS instance. Valid values of *N* vary based on the maximum number of security groups with which the instance can be associated. For more information, see the "Security group limits" section in the [Limits](~~25412~~) topic.'."\n" + ."\n" + .'> You cannot specify the **SecurityGroupId** and **SecurityGroupIds.N** parameters at the same time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of security group *N* with which you want to associate the ECS instance. Valid values of *N* vary based on the maximum number of security groups with which the instance can be associated. For more information, see the "Security group limits" section in the [Limits](~~25412~~) topic.'."\n" + ."\n" + .'> You cannot specify the **SecurityGroupId** and **SecurityGroupIds.N** parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp18kz60mefs****', + ], + 'required' => false, + 'example' => 'sg-bp18kz60mefs****', + 'maxItems' => 16, + ], + ], + [ + 'name' => 'InstancePatternInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The intelligent configuration settings, which determines the range of instance types that meet the specified criteria.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'description' => 'The number of vCPUs that is specified for an instance type in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. For more information, see [Instance family](~~25378~~). Valid values of *N*: 1 to 10.'."\n" + ."\n" + .'Take note of the following items:'."\n" + ."\n" + .'* The **InstancePatternInfo.N** parameter is available only for scaling groups that reside in VPCs.'."\n" + .'* You must specify the **InstancePatternInfo.N**, **InstancePatternInfo.N.Cores**, and **InstancePatternInfo.N.Memory** parameters at the same time.'."\n" + .'* If you specify an instance type by using the **InstanceType** or **InstanceTypes.N **parameter, Auto Scaling preferentially uses the instance type that is specified by the **InstanceType** or **InstanceTypes.N** parameter for scale-out activities. If the specified instance type does not have sufficient inventory, Auto Scaling creates instances of the instance type that is specified by the **InstancePatternInfo.N **parameter based on the price in ascending order.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'InstanceFamilyLevel' => [ + 'description' => 'The instance family level in intelligent configuration mode. This parameter is used to filter available instance types that meet the specified criteria. Valid values:'."\n" + ."\n" + .'* EntryLevel: shared instance type. Instances of this level are the most cost-effective but may not provide stable computing performance in a consistent manner. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see [Shared instance families](~~108489~~).'."\n" + .'* EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see [Instance family](~~25378~~).'."\n" + .'* CreditEntryLevel: This value is valid only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see [What are burstable instances?](~~59977~~)'."\n" + ."\n" + .'Valid values of *N*: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EnterpriseLevel', + ], + 'MaxPrice' => [ + 'description' => 'The maximum hourly price for a pay-as-you-go instance or a preemptible instance in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. Valid values of *N*: 1 to 10.'."\n" + ."\n" + .'> If you set the **SpotStrategy** parameter to **SpotWithPriceLimit**, you must specify this parameter. Otherwise, you do not need to specify this parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size that is specified for an instance type in intelligent configuration mode. Unit: GiB. This parameter is used to filter the available instance types that meet the specified criteria. For more information, see [Instance family](~~25378~~). Valid values of *N*: 1 to 10.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '4', + ], + 'ExcludedInstanceType' => [ + 'description' => 'Instance type *N* that you want to exclude. You can use wildcard characters such as an asterisk (\\*) to exclude a single instance type or an instance family. Examples:'."\n" + ."\n" + .'* ecs.c6.large: The ecs.c6.large instance type is excluded.'."\n" + .'* ecs.c6.\\*: The c6 instance family is excluded.', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance type *N* that you want to exclude. You can use wildcard characters such as an asterisk (\\*) to exclude a single instance type or an instance family. Examples:'."\n" + ."\n" + .'* ecs.c6.large: The ecs.c6.large instance type is excluded.'."\n" + .'* ecs.c6.\\*: The c6 instance family is excluded.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.small/ecs.n1.*/*7*', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'Architecture' => [ + 'description' => 'Architecture *N* of the instance type. Valid values:'."\n" + ."\n" + .'* X86: x86 architecture.'."\n" + .'* Heterogeneous: heterogeneous architecture, such as GPUs or FPGAs.'."\n" + .'* BareMetal: ECS Bare Metal Instance.'."\n" + .'* Arm: ARM architecture.'."\n" + .'* SuperComputeCluster: Super Computing Cluster architecture.'."\n" + ."\n" + .'By default, all values are selected.', + 'type' => 'array', + 'items' => [ + 'description' => 'Architecture *N* of the instance type. Valid values:'."\n" + ."\n" + .'* X86: x86 architecture.'."\n" + .'* Heterogeneous: heterogeneous architecture, such as GPUs or FPGAs.'."\n" + .'* BareMetal: ECS Bare Metal Instance.'."\n" + .'* Arm: ARM architecture.'."\n" + .'* SuperComputeCluster: Super Computing Cluster architecture.'."\n" + ."\n" + .'By default, all values are selected.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'BurstablePerformance' => [ + 'description' => 'Specifies whether to include burstable instance types. Valid values:'."\n" + ."\n" + .'* Exclude: does not include burstable instance types.'."\n" + .'* Include: includes burstable instance types.'."\n" + .'* Required: includes only burstable instance types.'."\n" + ."\n" + .'Default value: Include.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Include', + ], + 'InstanceTypeFamilies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'MinimumCpuCoreCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaximumCpuCoreCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'GpuSpecs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'InstanceCategories' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'CpuArchitectures' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'PhysicalProcessorModels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'MinimumEniQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumEniPrivateIpAddressQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumEniIpv6AddressQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumInitialCredit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumBaselineCredit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'MaximumMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'MinimumGpuAmount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaximumGpuAmount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SystemDiskCategories', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Category *N* of the system disk. Valid values of N: 1 to 4. You can specify up to four system disk categories in a scaling configuration. A smaller value of *N* specifies a higher priority. If Auto Scaling cannot create instances by using the system disk that has the highest priority, Auto Scaling creates instances by using the system disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + ."\n" + .'> You cannot specify the **SystemDiskCategories.N** and `SystemDisk.Category` parameters at the same time.', + 'type' => 'array', + 'items' => [ + 'description' => 'Category *N* of the system disk. Valid values of N: 1 to 4. You can specify up to four system disk categories in a scaling configuration. A smaller value of *N* specifies a higher priority. If Auto Scaling cannot create instances by using the system disk that has the highest priority, Auto Scaling creates instances by using the system disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + ."\n" + .'> You cannot specify the **SystemDiskCategories.N** and `SystemDisk.Category` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud', + ], + 'required' => false, + 'example' => 'cloud', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SystemDisk.Encrypted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to encrypt the system disk. Valid values:'."\n" + ."\n" + .'* true: encrypts the system disk.'."\n" + .'* false: does not encrypt the system disk.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SystemDisk.KMSKeyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the KMS key that is used to encrypt the system disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + ], + [ + 'name' => 'SystemDisk.EncryptAlgorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The algorithm that is used to encrypt the system disk. Valid values:'."\n" + ."\n" + .'* AES-256'."\n" + .'* SM4-128'."\n" + ."\n" + .'Default value: AES-256.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AES-256', + ], + ], + [ + 'name' => 'SystemDisk.ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preconfigured IOPS for the system disk.'."\n" + ."\n" + .'> IOPS measures the number of read and write operations that an EBS device can process per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'SystemDisk.BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the burst feature for the system disk. Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** This parameter is available only if you set the `SystemDisk.Category` parameter to `cloud_auto`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ImageOptions.LoginAsNonRoot', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => 'For more information about whether an ECS instance uses the ecs-user user user to log on to an ECS instance, see Manage the login name of an ECS instance. Value range:'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No.'."\n" + ."\n" + .'Default value: false.', + 'example' => 'false', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'StorageSetId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'StorageSetPartitionNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'CustomPriorities', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'VswitchId' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NetworkInterfaces', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'NetworkInterfaceTrafficMode' => [ + 'type' => 'string', + ], + 'Ipv6AddressCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SecurityGroupIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + 'SecondaryPrivateIpAddressCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'maxItems' => 10, + ], + ], + [ + 'name' => 'DedicatedHostClusterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SecurityOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConfidentialComputingMode' => [ + 'type' => 'string', + ], + ], + ], + ], + [ + 'name' => 'HttpEndpoint', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HttpTokens', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ResourcePoolOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Strategy' => [ + 'type' => 'string', + ], + 'PrivatePoolIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingConfigurationId' => [ + 'description' => 'The ID of the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'asc-bp1ffogfdauy0nu5****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingConfigurationId\\": \\"asc-bp1ffogfdauy0nu5****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScalingConfigurationResponse>\\n <ScalingConfigurationId>asc-bp1ffogfdauy0nu5****</ScalingConfigurationId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</CreateScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'CreateScalingConfiguration', + 'description' => '## Description'."\n" + ."\n" + .'Auto Scaling automatically scales out Elastic Compute Service (ECS) instances based on a scaling configuration. ECS instances can be configured in the following modes:'."\n" + ."\n" + .'* InstancePatternInfo.N: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. The system selects an instance type that is provided at the lowest price based on your configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode helps reduce the failures of scale-out activities caused by insufficient inventory of instance types.'."\n" + .'* InstanceType: In this mode, you must specify an instance type.'."\n" + .'* InstanceTypes.N: In this mode, you must specify multiple instance types.'."\n" + .'* InstanceTypeOverride.N: In this mode, you must specify multiple instance types and specify weights for the instance types.'."\n" + .'* Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines a set of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates ECS instances of the instance type that is provided at the lowest price. This mode is available only if the **Scaling Policy** parameter is set to** Cost Optimization Policy** and no instance type is specified in the scaling configuration.'."\n" + ."\n" + .'> You cannot use InstanceType, InstanceTypes.N, InstanceTypeOverride.N, and Cpu and Memory at the same time. You can use InstanceType and InstancePatternInfo.N or use InstanceTypes.N and InstancePatternInfo.N at the same time. If you use InstanceType and InstancePatternInfo.N or use InstanceTypes.N and InstancePatternInfo.N at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes.N for scale-out activities. If the instance types that are specified by InstanceType or InstanceTypes.N do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfo.N for scale-out activities.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteScalingConfiguration' => [ + 'summary' => '删除一个ECS类型伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92666', + 'abilityTreeNodes' => [ + 'FEATUREessTZHE2G', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling configuration to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asc-bp1bx8mzur534edp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request. This parameter is returned regardless of whether the operation is successful.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScalingConfigurationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DeleteScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'For more information about whether an ECS instance uses the ecs-user user user to log on to an ECS i', + 'description' => '## Description'."\n" + ."\n" + .'The scaling configuration cannot be deleted in one of the following conditions:'."\n" + ."\n" + .'* The scaling configuration in the scaling group is in the Active state.'."\n" + .'* The scaling group contains ECS instances that were created based on the scaling configuration.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyScalingConfiguration' => [ + 'summary' => '修改伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92708', + 'abilityTreeNodes' => [ + 'FEATUREessT4M3WE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling configuration that you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asc-bp16har3jpj6fjbx****', + ], + ], + [ + 'name' => 'IoOptimized', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the instance is an I/O optimized instance. Valid values:'."\n" + ."\n" + .'* none: The instance is a non-I/O optimized instance.'."\n" + .'* optimized: The instance is an I/O optimized instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy that you want to apply to pay-as-you-go instances and preemptible instances. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ScalingConfigurationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling configuration. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). It must start with a letter or a digit.'."\n" + ."\n" + .'The name of the scaling configuration must be unique within a scaling group in a region. If you do not specify this parameter, the value of the ScalingConfigurationId parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-modify', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Elastic Compute Service (ECS) instance that is created by Auto Scaling based on the scaling configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'inst****', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname of the ECS instance. The hostname cannot start or end with a period (.) or a hyphen (-). The hostname also cannot contain consecutive periods (.) or hyphens (-). Naming conventions:'."\n" + ."\n" + .'* Windows instances: The hostname must be 2 to 15 characters in length, and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.) or contain only digits.'."\n" + .'* Other instances such as Linux instances: The hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hos****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the image that is used by Auto Scaling to create instances.'."\n" + ."\n" + .'> If the image that is specified in the scaling configuration contains a system disk and data disks, the data that is stored in the data disks is cleared after you modify the image.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos6u5_64_20G_aliaegis_2014****.vhd', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image. The name must be unique in a region. If you specify the ImageId parameter, the ImageName parameter is ignored.'."\n" + ."\n" + .'You cannot use the ImageName parameter to specify images that are purchased from Alibaba Cloud Marketplace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'suse11sp3_64_20G_aliaegis_2015****.vhd', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of vCPUs.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify the Cpu and Memory parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.'."\n" + ."\n" + .'> You can specify CPU and memory specifications to determine the range of instance types only if the Scaling Policy parameter is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The memory size.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify the Cpu and Memory parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.'."\n" + ."\n" + .'> You can specify CPU and memory specifications to determine the range of instance types only if the Scaling Policy parameter is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method for network usage. Valid values:'."\n" + ."\n" + .'* PayByBandwidth: You are charged for the maximum available bandwidth that is specified by the InternetMaxBandwidthOut parameter.'."\n" + .'* PayByTraffic: You are charged for the actual traffic that is used. The InternetMaxBandwidthOut parameter specifies only the maximum available bandwidth.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayByBandwidth', + ], + ], + [ + 'name' => 'InternetMaxBandwidthOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum outbound public bandwidth. Unit: Mbit/s.'."\n" + ."\n" + .'* If you set the InternetChargeType parameter to PayByBandwidth and you leave this parameter empty, this parameter is automatically set to 0.'."\n" + .'* If you set the InternetChargeType parameter to PayByTraffic and you leave this parameter empty, an error is reported.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'SystemDisk.Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the system disk. Valid values:'."\n" + ."\n" + .'* cloud: basic disk'."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: enhanced SSD (ESSD)'."\n" + .'* ephemeral_ssd: local standard SSD'."\n" + .'* cloud_auto: ESSD AutoPL disk'."\n" + ."\n" + .'You cannot specify the SystemDisk.Category and `SystemDiskCategories.N` parameters at the same time. If you do not specify the SystemDisk.Category or `SystemDiskCategories.N` parameters, the default value of the SystemDisk.Category parameter is used. The default value of this parameter for non-I/O optimized instances of Generation I instance types is cloud. The default value of this parameter for instances of other types is cloud_efficiency.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + ], + [ + 'name' => 'SystemDisk.Size', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the system disk. Unit: GiB.'."\n" + ."\n" + .'* Valid values if you set the SystemDisk.Category parameter to cloud: 20 to 500.'."\n" + .'* Valid values if you set the SystemDisk.Category parameter to cloud_efficiency: 20 to 500'."\n" + .'* Valid values if you set the SystemDisk.Category parameter to cloud_ssd: 20 to 500'."\n" + .'* Valid values if you set the SystemDisk.Category parameter to cloud_essd: 20 to 500'."\n" + .'* Valid values if you set the SystemDisk.Category parameter to cloud_essd: 20 to 500'."\n" + ."\n" + .'The value of the SystemDisk.Size parameter must be greater than or equal to max{20, ImageSize}.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'SystemDisk.DiskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the system disk. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssdSystem', + ], + ], + [ + 'name' => 'SystemDisk.Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the system disk. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test system disk.', + ], + ], + [ + 'name' => 'SystemDisk.AutoSnapshotPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the automatic snapshot policy that you want to apply to the system disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sp-bp12m37ccmxvbmi5****', + ], + ], + [ + 'name' => 'SystemDisk.PerformanceLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance level (PL) of the system disk of the ESSD category. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'> For more information about how to select ESSD PLs, see [ESSDs](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'LoadBalancerWeight', + 'in' => 'query', + 'schema' => [ + 'description' => 'The weight of the ECS instance as a backend server. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user data of the ECS instance. The data must be encoded in Base64. The maximum size of the data before encoding is 16 KB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'echo hello ecs!', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the key pair that is used to log on to an ECS instance.'."\n" + ."\n" + .'* Windows instances do not use this parameter.'."\n" + .'* By default, the username and password authentication method is disabled for Linux instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'KeyPair_Name', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role that is associated with the ECS instance. The name is provided and maintained by Resource Access Management (RAM). You can call the [ListRoles](~~28713~~) operation to query the available RAM roles. For more information about how to create a RAM role, see [CreateRole](~~28710~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RamRoleTest', + ], + ], + [ + 'name' => 'PasswordInherit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use the password that is preconfigured in the image. Before you use this parameter, make sure that a password is configured for the image.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags of the ECS instance. The tags must be specified in the key-value format. You can specify up to 20 tags. The following rules apply to tag keys and tag values:'."\n" + ."\n" + .'* A tag key can be up to 64 characters in length. The key cannot start with `acs:` or `aliyun`, and cannot contain `http://` or `https://`. You cannot specify an empty string as a tag key.'."\n" + .'* A tag value can be up to 128 characters in length. The value cannot start with `acs:` or `aliyun`, and cannot contain `http://` or `https://`. You can specify an empty string as a tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"key1":"value1","key2":"value2", ... "key5":"value5"}', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the deployment set to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp13v7bjnj9gis****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group with which the ECS instance is associated. ECS instances that are associated with the same security group can access each other.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-F876F****', + ], + ], + [ + 'name' => 'Override', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to overwrite existing data. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcd1234abcd****', + ], + ], + [ + 'name' => 'HpcClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Elastic High Performance Computing (E-HPC) cluster to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hpc-clusterid', + ], + ], + [ + 'name' => 'InstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the ECS instance. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test instance.', + ], + ], + [ + 'name' => 'Ipv6AddressCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of randomly generated IPv6 addresses that you want to allocate to the elastic network interface (ENI).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CreditSpecification', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance mode of the burstable instance. Valid values:'."\n" + ."\n" + .'* Standard: standard mode. For more information, see the "Standard mode" section in the [Overview](~~59977~~) topic of burstable instances.'."\n" + .'* Unlimited: unlimited mode. For more information, see the "Unlimited mode" section in the [Overview](~~59977~~) topic of burstable instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'ImageFamily', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image family. You can specify this parameter to obtain the latest custom images that are available in the specified image family. You can use the images to create instances. If you specify the ImageId parameter, you cannot specify the ImageFamily parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou-daily-update', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the ECS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'DedicatedHostId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dedicated host on which you want to create the ECS instance. Preemptible instances cannot be created on dedicated hosts. If you specify the DedicatedHostId parameter, the SpotStrategy and SpotPriceLimit parameters are ignored.'."\n" + ."\n" + .'You can call the [DescribeDedicatedHosts](~~134242~~) operation to query dedicated host IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dh-bp67acfmxazb4p****', + ], + ], + [ + 'name' => 'Affinity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to associate an instance on a dedicated host with the dedicated host. Valid values:'."\n" + ."\n" + .'* default: does not associate the instance with the dedicated host. If you start an instance that was stopped in economical mode and the original dedicated host of the instance has insufficient resources, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool.'."\n" + .'* host: associates the instance with the dedicated host. If you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the instance cannot be started.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Tenancy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to create the instance on a dedicated host. Valid values:'."\n" + ."\n" + .'* default: does not create the instance on a dedicated host.'."\n" + .'* host: creates the instance on a dedicated host. If you do not specify the DedicatedHostId parameter, the system selects a dedicated host for the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SchedulerOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The options of the scheduler.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '["testManagedPrivateSpaceId****"]', + ], + ], + [ + 'name' => 'PrivatePoolOptions.MatchCriteria', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the private pool. A private pool is generated after an elasticity assurance or a capacity reservation takes effect. You can select the private pool when you start an instance. Valid values:'."\n" + ."\n" + .'* Open: open private pool. The system selects a matching open private pool to start the instance. If no matching open private pools are found, the resources in the public pool are used. In this case, you do not need to specify the PrivatePoolOptions.Id parameter.'."\n" + .'* Target: specified private pool. The resources in the specified private pool are used to start the instance. If the specified private pool is unavailable, the instance cannot be started. If you set this parameter to Target, you must specify the PrivatePoolOptions.Id parameter.'."\n" + .'* None: no private pool. The resources in private pools are not used to start the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Open', + ], + ], + [ + 'name' => 'PrivatePoolOptions.Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the private pool. The ID of a private pool is the same as the ID of the elasticity assurance or capacity reservation for which the private pool is generated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eap-bp67acfmxazb4****', + ], + ], + [ + 'name' => 'SpotDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.'."\n" + ."\n" + .'* The following retention periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket.'."\n" + .'* If you set this parameter to 0, no retention period is specified for the preemptible instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SpotInterruptionBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interruption mode of the preemptible instance. Default value: Terminate. Set the value to Terminate, which specifies that the preemptible instance is to be released.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Terminate', + ], + ], + [ + 'name' => 'DataDisk', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PerformanceLevel' => [ + 'description' => 'The PL of data disk N that is of the ESSD category. If you set the DataDisk.N.Category parameter to cloud_essd, the N value must be the same as the N value in DataDisk.N.Category. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'> For more information about how to select ESSD PLs, see [ESSDs](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => 'The ID of the automatic snapshot policy that you want to apply to data disk N. Valid values of N: 1 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sp-bp19nq9enxqkomib****', + ], + 'Encrypted' => [ + 'description' => 'Specifies whether to encrypt data disk N. Valid values of N: 1 to 16. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'Description' => [ + 'description' => 'The description of data disk N. Valid values of N: 1 to 16. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test data disk.', + ], + 'SnapshotId' => [ + 'description' => 'The ID of the snapshot that you want to use to create data disk N. Valid values of N: 1 to 16. If you specify this parameter, the DataDisk.N.Size parameter is ignored. The size of the disk is the same as the size of the specified snapshot.'."\n" + ."\n" + .'If you specify a snapshot created on or before July 15, 2013, the operation fails and the system returns InvalidSnapshot.TooOld.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 's-snapshot****', + ], + 'Categories' => [ + 'description' => 'Category N of data disk N. The first N in DataDisk.N.Categories.N represents the serial number of the data disk. Valid values of N: 1 to 16. The second N in DataDisk.N.Categories.N represents the serial number of the category of data disk N. Valid values of N: 1 to 4. You can specify up to four data disk categories in a scaling configuration. A smaller value of N specifies a higher priority. If Auto Scaling cannot create instances by using the disk that has the highest priority, Auto Scaling creates instances by using the disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with the instance is set to true.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + ."\n" + .'> You cannot specify the DataDisk.N.Categories.N and `DataDisk.N.Category` parameters at the same time.', + 'type' => 'array', + 'items' => [ + 'description' => 'Category N of data disk N. The first N in DataDisk.N.Categories.N represents the serial number of the data disk. Valid values of N: 1 to 16. The second N in DataDisk.N.Categories.N represents the serial number of the category of data disk N. Valid values of N: 1 to 4. You can specify up to four data disk categories in a scaling configuration. A smaller value of N specifies a higher priority. If Auto Scaling cannot create instances by using the disk that has the highest priority, Auto Scaling creates instances by using the disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with the instance is set to true.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + ."\n" + .'> You cannot specify the DataDisk.N.Categories.N and `DataDisk.N.Category` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud', + ], + 'required' => false, + 'example' => 'cloud', + 'maxItems' => 10, + ], + 'Size' => [ + 'description' => 'The size of data disk N. Unit: GiB. Valid values of N: 1 to 16.'."\n" + ."\n" + .'* Valid values if you set the DataDisk.N.Category parameter to cloud: 5 to 2000.'."\n" + .'* Valid values if you set the DataDisk.N.Category parameter to cloud_efficiency: 20 to 32768.'."\n" + .'* Valid values if you set the DataDisk.N.Category parameter to cloud_essd: 20 to 32768.'."\n" + .'* Valid values if you set the DataDisk.N.Category parameter to ephemeral_ssd: 5 to 800.'."\n" + ."\n" + .'The value of the DataDisk.N.Size parameter must be greater than or equal to the size of the snapshot that is specified by the SnapshotId parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Device' => [ + 'description' => 'The mount target of data disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the system automatically assigns a mount target when Auto Scaling creates ECS instances. The name of the mount target ranges from /dev/xvdb to /dev/xvdz.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/dev/xvdb', + ], + 'DiskName' => [ + 'description' => 'The name of data disk N. Valid values of N: 1 to 16. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssdData', + ], + 'Category' => [ + 'description' => 'The category of data disk N. Valid values of N: 1 to 16. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with the instance is set to true.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + .'* ephemeral_ssd: local standard SSD.'."\n" + .'* cloud_auto: ESSD AutoPL disk.'."\n" + ."\n" + .'You cannot specify the DataDisk.N.Category and `DataDisk.N.Categories.N` parameters at the same time. If you do not specify the DataDisk.N.Category or `DataDisk.N.Categories.N` parameters, the default value of the DataDisk.N.Category parameter is used.'."\n" + ."\n" + .'* The default value is cloud_efficiency for I/O optimized instances.'."\n" + .'* The default value is cloud for non-I/O optimized instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + 'DeleteWithInstance' => [ + 'description' => 'Specifies whether to release data disk N when the instance to which data disk N is attached is released. Valid values of N: 1 to 16. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'This parameter is available only for independent disks whose DataDisk.N.Category parameter is set to cloud, cloud_efficiency, cloud_ssd, or cloud_essd. If you specify this parameter for disks of other categories, an error is reported.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'KMSKeyId' => [ + 'description' => 'The ID of the Key Management Service (KMS) key that is used to encrypt data disk N. Valid values of N: 1 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'ProvisionedIops' => [ + 'description' => 'The preconfigured input/output operations per second (IOPS) for data disk N.'."\n" + ."\n" + .'> IOPS measures the number of read and write operations that an Elastic Block Storage (EBS) device can process per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'BurstingEnabled' => [ + 'description' => 'Specifies whether to enable the burst feature for data disk N. Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** This parameter is available only if you set the `DataDisk.Category` parameter to `cloud_auto`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The maximum hourly price of the preemptible elastic container instance. The value can be accurate to three decimal places.'."\n" + ."\n" + .'If you set the SpotStrategy parameter to SpotWithPriceLimit, you must also specify the SpotPriceLimit parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PriceLimit' => [ + 'description' => 'The price limit of preemptible instance N. Valid values of N: 1 to 10. This parameter is available only if you set the SpotStrategy parameter to SpotWithPriceLimit.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.125', + ], + 'InstanceType' => [ + 'description' => 'The instance type of preemptible instance N. Valid values of N: 1 to 10. This parameter is available only if you set the SpotStrategy parameter to SpotWithPriceLimit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Instance type N. If you specify this parameter, the InstanceType parameter is ignored. Valid values of N: 1 to 10.'."\n" + ."\n" + .'The first instance type has the highest priority. The priority decreases based on the specified orders of the instance types. Auto Scaling creates instances based on the priorities of instance types. If Auto Scaling cannot create instances of the instance type that has the highest priority, Auto Scaling creates instances of the instance type that has the next highest priority.', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance type N. If you specify this parameter, the InstanceType parameter is ignored. Valid values of N: 1 to 10.'."\n" + ."\n" + .'The first instance type has the highest priority. The priority decreases based on the specified orders of the instance types. Auto Scaling creates instances based on the priorities of instance types. If Auto Scaling cannot create instances of the instance type that has the highest priority, Auto Scaling creates instances of the instance type that has the next highest priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + 'required' => false, + 'example' => 'ecs.g6.large', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceTypeOverride', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance type overrides.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'Instance type N that you want to use to override the instance type that is specified in the launch template. If you want to specify the weighted capacity of instance type N in the scaling configuration, you must specify the InstanceTypeOverride.N.InstanceType parameter and the InstanceTypeOverride.N.WeightedCapacity parameter at the same time.'."\n" + ."\n" + .'The InstanceTypeOverride.N.InstanceType parameter specifies instance type N, and the InstanceTypeOverride.N.WeightedCapacity parameter specifies the weighted capacity of the specified instance type in the scaling configuration. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> You cannot specify the InstanceTypeOverride.N.InstanceType and InstanceTypes parameters at the same time.'."\n" + ."\n" + .'For information about valid values of InstanceType in InstanceTypeOverride.N.InstanceType, see [Instance families](~~25378~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c5.xlarge', + ], + 'WeightedCapacity' => [ + 'description' => 'The weight of instance type N. If you want to specify the weighted capacity of instance type N in the scaling configuration, you must specify the InstanceTypeOverride.N.InstanceType parameter and the InstanceTypeOverride.N.WeightedCapacity parameter at the same time. The value of N in the two parameters must be the same.'."\n" + ."\n" + .'The weight specifies the capacity of an instance of instance type N in the scaling group. A higher weight specifies that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.'."\n" + ."\n" + .'Performance metrics, such as the number of vCPUs and the memory size of each instance type, may vary. You can specify different weights for different instance types based on your business requirements.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'* Current capacity: 0'."\n" + .'* Expected capacity: 6'."\n" + .'* Capacity of ecs.c5.xlarge: 4'."\n" + ."\n" + .'To meet the expected capacity requirement, Auto Scaling must create two ecs.c5.xlarge instances.'."\n" + ."\n" + .'> The capacity of the scaling group cannot exceed the sum of the maximum number of instances that is specified by the MaxSize parameter and the maximum weight of the instance types.'."\n" + ."\n" + .'Valid values of WeightedCapacity in the InstanceTypeOverride.N.WeightedCapacity parameter: 1 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'SecurityGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the security groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp18kz60mefs****', + ], + 'required' => false, + 'example' => 'sg-bp18kz60mefs****', + 'maxItems' => 16, + ], + ], + [ + 'name' => 'InstancePatternInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the intelligent configuration settings, which determines the range of instance types that meet the specified criteria.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'description' => 'The number of vCPUs that is provided for instance type N in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. For more information, see [Overview of instance families](~~25378~~). Valid values of N: 1 to 10'."\n" + ."\n" + .'Take note of the following items:'."\n" + ."\n" + .'* The InstancePatternInfo.N parameter is available only for scaling groups that reside in virtual private clouds (VPCs).'."\n" + .'* You must specify the InstancePatternInfo.N, InstancePatternInfo.N.Cores, and InstancePatternInfo.N.Memory parameters at the same time.'."\n" + .'* If you specify an instance type by using the InstanceType or InstanceTypes.N parameter, Auto Scaling preferentially uses the instance type that is specified by the InstanceType or InstanceTypes.N parameter for scale-out activities. If the specified instance type does not have sufficient inventory, Auto Scaling creates instances of the instance type that is specified by the InstancePatternInfo.N parameter and provided at the lowest price.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'InstanceFamilyLevel' => [ + 'description' => 'The instance family level in intelligent configuration mode. This parameter is used to filter available instance types that meet the specified criteria. Valid values:'."\n" + ."\n" + .'* EntryLevel: shared instance type. Instances of this level are cost-effective, but do not provide stable computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low. For more information, see [Shared instance families](~~108489~~).'."\n" + .'* EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see [Overview of instance families](~~25378~~).'."\n" + .'* CreditEntryLevel: This value is available only for burstable instances. CPU credits are used to ensure computing performance. This level is suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see [Overview](~~59977~~) of burstable instances'."\n" + ."\n" + .'Valid values of N: 1 to 10'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EnterpriseLevel', + ], + 'MaxPrice' => [ + 'description' => 'The maximum hourly price for a pay-as-you-go instance or a preemptible instance in intelligent configuration mode. This parameter is used to filter the available instance types that meet the specified criteria. Valid values of N: 1 to 10'."\n" + ."\n" + .'> If you set the SpotStrategy parameter to SpotWithPriceLimit, you must specify this parameter. In other cases, you do not need to specify this parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size that is provided for instance type N in intelligent configuration mode. Unit: GiB. This parameter is used to filter the available instance types that meet the specified criteria. For more information, see [Overview of instance families](~~25378~~). Valid values of N: 1 to 10'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '4', + ], + 'Architecture' => [ + 'description' => 'Architecture N of instance type N. Valid values:'."\n" + ."\n" + .'* X86: x86 architecture.'."\n" + .'* Heterogeneous: heterogeneous architecture, such as GPUs and FPGAs.'."\n" + .'* BareMetal: ECS Bare Metal Instance architecture.'."\n" + .'* Arm: ARM architecture.'."\n" + .'* SuperComputeCluster: Super Computing Cluster architecture.'."\n" + ."\n" + .'By default, all values are included.', + 'type' => 'array', + 'items' => [ + 'description' => 'Architecture N of instance type N. Valid values:'."\n" + ."\n" + .'* X86: x86 architecture.'."\n" + .'* Heterogeneous: heterogeneous architecture, such as GPUs and FPGAs.'."\n" + .'* BareMetal: ECS Bare Metal Instance architecture.'."\n" + .'* Arm: ARM architecture.'."\n" + .'* SuperComputeCluster: Super Computing Cluster architecture.'."\n" + ."\n" + .'By default, all values are included.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'BurstablePerformance' => [ + 'description' => 'Specifies whether to include burstable instance types. Valid values:'."\n" + ."\n" + .'* Exclude: does not include burstable instance types.'."\n" + .'* Include: includes burstable instance types.'."\n" + .'* Required: includes only burstable instance types.'."\n" + ."\n" + .'Default value: Include.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Include', + ], + 'ExcludedInstanceType' => [ + 'description' => 'Instance type N that you want to exclude. You can use wildcard characters such as an asterisk (\\*) to exclude an instance type or an instance family. Examples:'."\n" + ."\n" + .'* ecs.c6.large: excludes the ecs.c6.large instance type'."\n" + .'* ecs.c6.\\*: excludes the c6 instance family.'."\n" + ."\n" + .'> Separate multiple instance types with forward slashes (/). Example: `ecs.n1.small/ecs.n1.*/*7*`.', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance type N that you want to exclude. You can use wildcard characters such as an asterisk (\\*) to exclude an instance type or an instance family. Examples:'."\n" + ."\n" + .'* ecs.c6.large: excludes the ecs.c6.large instance type'."\n" + .'* ecs.c6.\\*: excludes the c6 instance family.'."\n" + ."\n" + .'> Separate multiple instance types with forward slashes (/). Example: `ecs.n1.small/ecs.n1.*/*7*`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.small/ecs.n1.*/*7*', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'InstanceTypeFamilies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'MinimumCpuCoreCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaximumCpuCoreCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'GpuSpecs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'InstanceCategories' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'CpuArchitectures' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'PhysicalProcessorModels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + 'MinimumEniQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumEniPrivateIpAddressQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumEniIpv6AddressQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumInitialCredit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumBaselineCredit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'MaximumMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'MinimumGpuAmount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaximumGpuAmount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SystemDiskCategories', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Category N of the system disk. Valid values of N: 1 to 4. A smaller value of N indicates a higher priority. If Auto Scaling cannot create instances by using the disk that has the highest priority, Auto Scaling creates instances by using the disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk'."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n" + ."\n" + .'> You cannot specify the SystemDiskCategories.N and `SystemDisk.Category` parameters at the same time.', + 'type' => 'array', + 'items' => [ + 'description' => 'Category N of the system disk. Valid values of N: 1 to 4. A smaller value of N indicates a higher priority. If Auto Scaling cannot create instances by using the disk that has the highest priority, Auto Scaling creates instances by using the disk that has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk'."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n" + ."\n" + .'> You cannot specify the SystemDiskCategories.N and `SystemDisk.Category` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud', + ], + 'required' => false, + 'example' => 'cloud', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SystemDisk.Encrypted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to encrypt the system disk. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SystemDisk.KMSKeyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the KMS key that is used to encrypt the system disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + ], + [ + 'name' => 'SystemDisk.EncryptAlgorithm', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption algorithm that is used to encrypt the system disk. Valid values:'."\n" + ."\n" + .'* AES-256'."\n" + .'* SM4-128'."\n" + ."\n" + .'Default value: AES-256.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AES-256', + ], + ], + [ + 'name' => 'SystemDisk.ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preconfigured IOPS for the system disk.'."\n" + ."\n" + .'> IOPS measures the number of read and write operations that an EBS device can process per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'SystemDisk.BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the burst feature for the system disk. Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** This parameter is available only if you set the `SystemDisk.Category` parameter to `cloud_auto`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ImageOptions.LoginAsNonRoot', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'description' => 'For more information about whether an ECS instance uses the ecs-user user user to log on to an ECS instance, see Manage the login name of an ECS instance. Value range:'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No.'."\n" + ."\n" + .'Default value: false.', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'StorageSetId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'StorageSetPartitionNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'CustomPriorities', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'VswitchId' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NetworkInterfaces', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'NetworkInterfaceTrafficMode' => [ + 'type' => 'string', + ], + 'Ipv6AddressCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SecurityGroupIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + 'SecondaryPrivateIpAddressCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'maxItems' => 10, + ], + ], + [ + 'name' => 'DedicatedHostClusterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SecurityOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ConfidentialComputingMode' => [ + 'type' => 'string', + ], + ], + ], + ], + [ + 'name' => 'HttpEndpoint', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HttpTokens', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'InternetMaxBandwidthIn', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'ResourcePoolOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Strategy' => [ + 'type' => 'string', + ], + 'PrivatePoolIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyScalingConfigurationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'ModifyScalingConfiguration', + 'description' => '## Description'."\n" + ."\n" + .'If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeScalingConfigurations' => [ + 'summary' => '查询伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92682', + 'abilityTreeNodes' => [ + 'FEATUREessVYTHU5', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group whose scaling configurations you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '50', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group. You can query all scaling configurations in the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp17pelvl720x3v7****', + ], + ], + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ScalingConfigurationId', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of scaling configuration N that you want to query.'."\n" + ."\n" + .'The IDs of active and inactive scaling configurations are displayed in the query results. You can distinguish active and inactive scaling configurations based on the value of `LifecycleState`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc-bp17pelvl720x5ub****', + ], + 'required' => false, + 'example' => 'asc-bp17pelvl720x5ub****', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ScalingConfigurationName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The name of scaling configuration N that you want to query.'."\n" + ."\n" + .'The names of inactive scaling configurations are not displayed in the query results, and no error is reported.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of scaling configuration N that you want to query.'."\n" + ."\n" + .'The names of inactive scaling configurations are not displayed in the query results, and no error is reported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalingcon****', + ], + 'required' => false, + 'example' => 'scalingcon****', + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of scaling configurations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingConfigurations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScalingConfiguration' => [ + 'description' => 'The scaling configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DeploymentSetId' => [ + 'description' => 'The ID of the deployment set of the ECS instances that were created from the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'ds-bp1frxuzdg87zh4p****', + ], + 'CreationTime' => [ + 'description' => 'The time when the scaling configuration was created.'."\n", + 'type' => 'string', + 'example' => '2014-08-14T10:58Z', + ], + 'ScalingConfigurationName' => [ + 'description' => 'The name of the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'scalingconfigura****', + ], + 'SystemDiskDescription' => [ + 'description' => 'The description of the system disk.'."\n", + 'type' => 'string', + 'example' => 'Test system disk.', + ], + 'KeyPairName' => [ + 'description' => 'The name of the key pair that is used to log on to an ECS instance.'."\n", + 'type' => 'string', + 'example' => 'keypair****', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group with which the ECS instances that are created from the scaling configuration are associated. The ECS instances that are associated with the same security group can access each other.'."\n", + 'type' => 'string', + 'example' => 'sg-bp18kz60mefs****', + ], + 'PrivatePoolOptions.Id' => [ + 'description' => 'The ID of the private pool. The ID of a private pool is the same as the ID of the elasticity assurance or capacity reservation for which the private pool is generated.'."\n", + 'type' => 'string', + 'example' => 'eap-bp67acfmxazb4****', + ], + 'SystemDiskAutoSnapshotPolicyId' => [ + 'description' => 'The ID of the automatic snapshot policy that is applied to the system disk.'."\n", + 'type' => 'string', + 'example' => 'sp-bp12m37ccmxvbmi5****', + ], + 'SpotStrategy' => [ + 'description' => 'The preemption policy that is applied to pay-as-you-go instances and preemptible instances. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is a preemptible instance that has a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group whose scaling configuration was queried.'."\n", + 'type' => 'string', + 'example' => 'asg-bp17pelvl720x3v7****', + ], + 'Affinity' => [ + 'description' => 'Indicates whether an ECS instance on a dedicated host is associated with the dedicated host. Valid values:'."\n" + ."\n" + .'* default: The ECS instance is not associated with the dedicated host. If you start an ECS instance that was stopped in economical mode and the original dedicated host of the ECS instance has insufficient resources, the ECS instance is automatically deployed to another dedicated host in the automatic deployment resource pool.'."\n" + .'* host: The ECS instance is associated with the dedicated host. If you start an ECS instance that was stopped in economical mode, the ECS instance remains on the original dedicated host. If the resources of the original dedicated host are insufficient, you cannot start the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Tenancy' => [ + 'description' => 'Indicates whether the ECS instance is created on a dedicated host. Valid values:'."\n" + ."\n" + .'* default: The ECS instance is created on a non-dedicated host.'."\n" + .'* host: The ECS instance is created on a dedicated host. If you do not specify `DedicatedHostId`, Alibaba Cloud selects a dedicated host for the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'SystemDiskSize' => [ + 'description' => 'The size of the system disk. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Ipv6AddressCount' => [ + 'description' => 'The number of randomly generated IPv6 addresses that are allocated to the elastic network interface (ENI).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SpotDuration' => [ + 'description' => 'The retention period of a preemptible instance. Unit: hours.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LifecycleState' => [ + 'description' => 'The status of the scaling configuration in the scaling group. Valid values:'."\n" + ."\n" + .'* Active: The scaling configuration is active in the scaling group. Auto Scaling uses the active scaling configuration to automatically create ECS instances.'."\n" + .'* Inactive: The scaling configuration is inactive in the scaling group. Auto Scaling does not use the inactive scaling configuration to create ECS instances. Inactive scaling configurations are retained in the scaling group.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'InstanceName' => [ + 'description' => 'The name of the ECS instance that is created from the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'instance****', + ], + 'SecurityEnhancementStrategy' => [ + 'description' => 'Indicates whether the security hardening feature is enabled. Valid values:'."\n" + ."\n" + .'* Active: Security hardening is enabled. This value is applicable only to public images.'."\n" + .'* Deactive: Security hardening is disabled. This value is applicable to all image types.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'UserData' => [ + 'description' => 'The user data of the ECS instance that is created from the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'echo hello ecs!', + ], + 'PrivatePoolOptions.MatchCriteria' => [ + 'description' => 'The type of the private pool. A private pool is generated when an elasticity assurance or a capacity reservation takes effect. You can select a private pool for Auto Scaling to start instances. Valid values:'."\n" + ."\n" + .'* Open: open private pool. Auto Scaling selects a matching open private pool to start instances. If no matching open private pools exist, Auto Scaling uses the resources in the public pool to start instances.'."\n" + .'* Target: specified private pool. Auto Scaling uses the resources in the specified private pool to start instances. If the resources in the specified private pool are insufficient, instances cannot be started.'."\n" + .'* None: no private pool. Auto Scaling does not use the resources in private pools to start instances.'."\n", + 'type' => 'string', + 'example' => 'Open', + ], + 'DedicatedHostId' => [ + 'description' => 'The ID of the dedicated host on which the ECS instance is created. If you specify `DedicatedHostId`, `SpotStrategy` and `SpotPriceLimit` are ignored. Because preemptible instances cannot be created on dedicated hosts.'."\n" + ."\n" + .'You can call the [DescribeDedicatedHosts](~~134242~~) operation to query the IDs of dedicated hosts.'."\n", + 'type' => 'string', + 'example' => 'dh-bp67acfmxazb4p****', + ], + 'InstanceGeneration' => [ + 'description' => 'The generation of the ECS instance that is created from the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'ecs-3', + ], + 'HpcClusterId' => [ + 'description' => 'The ID of the Elastic High Performance Computing (E-HPC) cluster to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'example' => 'hpc-clus****', + ], + 'PasswordInherit' => [ + 'description' => 'Indicates whether the password that is preconfigured in the image is used.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Memory' => [ + 'description' => 'The memory size. Unit: GiB.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set CPU to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances by using the lowest-priced instance type.'."\n" + ."\n" + .'> You can specify Cpu and Memory to create instances only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'ImageId' => [ + 'description' => 'The ID of the image that is used by Auto Scaling to automatically create instances.'."\n", + 'type' => 'string', + 'example' => 'centos6u5_64_20G_aliaegis_2014****.vhd', + ], + 'ImageFamily' => [ + 'description' => 'The name of the image family. You can specify this parameter to obtain the most recent custom images that are available in the specified image family. Then, you can use the images to create instances. If you specify ImageId, you cannot specify ImageFamily.'."\n", + 'type' => 'string', + 'example' => 'hangzhou-daily-update', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The source of the image. Valid values:'."\n" + ."\n" + .'* system: Alibaba Cloud public image.'."\n" + .'* self: custom image that you create.'."\n" + .'* others: shared image from another Alibaba Cloud account or community image that is published by another Alibaba Cloud account.'."\n" + .'* marketplace: Alibaba Cloud Marketplace image.'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'LoadBalancerWeight' => [ + 'description' => 'The weight of an ECS instance as a backend server. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SystemDiskCategory' => [ + 'description' => 'The category of the system disk. Valid values:'."\n" + ."\n" + .'* cloud: basic disk.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* ephemeral_ssd: local SSD.'."\n" + .'* cloud_essd: enhanced SSD (ESSD).'."\n" + .'* cloud_auto: ESSD AutoPL disk.'."\n", + 'type' => 'string', + 'example' => 'cloud', + ], + 'HostName' => [ + 'description' => 'The hostname of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'LocalHost', + ], + 'SystemDiskName' => [ + 'description' => 'The name of the system disk.'."\n", + 'type' => 'string', + 'example' => 'cloud_ssd_Test', + ], + 'InternetMaxBandwidthOut' => [ + 'description' => 'The maximum outbound public bandwidth. Unit: Mbit/s.'."\n" + ."\n" + .'* Valid values if you set InternetChargeType to PayByBandwidth: 0 to 100. If you do not specify this parameter, a value of 0 is returned.'."\n" + .'* Valid values if you set InternetChargeType to PayByTraffic: 0 to 100. If this parameter is not specified, an error is reported.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InternetMaxBandwidthIn' => [ + 'description' => 'The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: 1 to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'IoOptimized' => [ + 'description' => 'Indicates whether the ECS instance is I/O optimized. Valid values:'."\n" + ."\n" + .'* none: The ECS instance is not I/O optimized.'."\n" + .'* optimized: The ECS instance is I/O optimized.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'RamRoleName' => [ + 'description' => 'The name of the RAM role that is associated with the ECS instance. The name is provided and maintained by Resource Access Management (RAM). You can call the [ListRoles](~~28713~~) operation to query the available RAM roles. You can call the [CreateRole](~~28710~~) operation to create RAM roles.'."\n", + 'type' => 'string', + 'example' => 'ramrole****', + ], + 'SystemDiskPerformanceLevel' => [ + 'description' => 'The performance level (PL) of the system disk that is an ESSD.'."\n", + 'type' => 'string', + 'example' => 'PL1', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set CPU to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances by using the lowest-priced instance type.'."\n" + ."\n" + .'> You can specify Cpu and Memory to create instances only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the ECS instance belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-aekzn2ou7xo****', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the ECS instance. You can call the [DescribeZones](~~25610~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'InternetChargeType' => [ + 'description' => 'The metering method for network usage. Valid values:'."\n" + ."\n" + .'* PayByBandwidth: You are charged for the maximum available bandwidth that is specified by InternetMaxBandwidthOut.'."\n" + .'* PayByTraffic: You are charged for the actual data transfer. InternetMaxBandwidthOut specifies only the maximum available bandwidth.'."\n", + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'ImageName' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'example' => 'centos6u5_64_20G_aliaegis_20140703.vhd', + ], + 'ScalingConfigurationId' => [ + 'description' => 'The ID of the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'asc-bp1ezrfgoyn5kijl****', + ], + 'CreditSpecification' => [ + 'description' => 'The performance mode of the burstable instance. Valid values:'."\n" + ."\n" + .'* Standard: standard mode. For more information, see the "Standard mode" section in the [Burstable instances](~~59977~~) topic.'."\n" + .'* Unlimited: unlimited mode. For more information, see the "Unlimited mode" section in the [Burstable instances](~~59977~~) topic.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'SpotInterruptionBehavior' => [ + 'description' => 'The interruption mode of the preemptible instance.'."\n", + 'type' => 'string', + 'example' => 'Terminate', + ], + 'DataDisks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataDisk' => [ + 'description' => 'The data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PerformanceLevel' => [ + 'description' => 'The PL of the data disk that is an ESSD.'."\n", + 'type' => 'string', + 'example' => 'PL1', + ], + 'Description' => [ + 'description' => 'The description of the data disk.'."\n", + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'SnapshotId' => [ + 'description' => 'The ID of the snapshot that is used to create the data disk.'."\n", + 'type' => 'string', + 'example' => 's-23f2i****', + ], + 'Device' => [ + 'description' => 'The mount target of the data disk.'."\n", + 'type' => 'string', + 'example' => '/dev/xvdb', + ], + 'Size' => [ + 'description' => 'The size of the data disk. Unit: GiB.'."\n" + ."\n" + .'* Valid values if you set Category to cloud: 5 to 2000.'."\n" + .'* Valid values if you set Category to cloud_efficiency: 20 to 32768.'."\n" + .'* Valid values if you set Category to cloud_ssd: 20 to 32768.'."\n" + .'* Valid values if you set Category to cloud_essd: 20 to 32768.'."\n" + .'* Valid values if you set Category to ephemeral_ssd: 5 to 800.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'DiskName' => [ + 'description' => 'The name of the data disk.'."\n", + 'type' => 'string', + 'example' => 'cloud_ssdData', + ], + 'AutoSnapshotPolicyId' => [ + 'description' => 'The ID of the automatic snapshot policy that is applied to the data disk.'."\n", + 'type' => 'string', + 'example' => 'sp-bp19nq9enxqkomib****', + ], + 'Category' => [ + 'description' => 'The category of the data disk. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. DeleteWithInstance of a basic disk that is created together with the instance is set to true.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* ephemeral_ssd: local SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + .'* cloud_auto: ESSD AutoPL disk.'."\n", + 'type' => 'string', + 'example' => 'cloud', + ], + 'KMSKeyId' => [ + 'description' => 'The ID of the Key Management Service (KMS) key that is used to encrypt the data disk.'."\n", + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'DeleteWithInstance' => [ + 'description' => 'Indicates whether the data disk is released together with the ECS instance. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Encrypted' => [ + 'description' => 'Indicates whether the data disk is encrypted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Categories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Category' => [ + 'description' => 'The categories of the data disks. The first value has the highest priority. Other values are arranged in descending order of priorities. If Auto Scaling cannot create instances by using the disk category of the highest priority, Auto Scaling creates instances by using the disk category of the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. DeleteWithInstance of a basic disk that is created together with the instance is set to true.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The categories of the data disks. The first value has the highest priority. Other values are arranged in descending order of priorities. If Auto Scaling cannot create instances by using the disk category of the highest priority, Auto Scaling creates instances by using the disk category of the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk. DeleteWithInstance of a basic disk that is created together with the instance is set to true.'."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + ], + ], + ], + 'ProvisionedIops' => [ + 'description' => 'The IOPS metric that is preconfigured for the data disk.'."\n" + ."\n" + .'> IOPS measures the number of read and write operations that an Elastic Block Storage (EBS) device can process per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'BurstingEnabled' => [ + 'description' => 'Indicates whether the burst feature is enabled for the data disk. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'> This parameter is available only if you set `DataDisk.Category` to `cloud_auto`.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'Details of the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N. Valid values of N: 1 to 20.'."\n" + ."\n" + .'The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `acs:` or `aliyun`. The tag key cannot contain ``http://`` or ``https://``.', + 'type' => 'string', + 'example' => 'binary', + ], + 'Value' => [ + 'description' => 'The value of tag N. Valid values of N: 1 to 20.'."\n" + ."\n" + .'The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.', + 'type' => 'string', + 'example' => 'alterTable', + ], + ], + ], + ], + ], + ], + 'SpotPriceLimit' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SpotPriceModel' => [ + 'description' => 'Details of the preemptible instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the preemptible instances.', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the preemptible instance.', + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + 'PriceLimit' => [ + 'description' => 'The price limit of the preemptible instance.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.125', + ], + ], + ], + ], + ], + ], + 'InstancePatternInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstancePatternInfo' => [ + 'description' => 'Details of the intelligent configuration settings, which determines the range of instance types that meet the specified criteria.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the intelligent configuration settings, which determines the range of instance types that meet the specified criteria.', + 'type' => 'object', + 'properties' => [ + 'MaxPrice' => [ + 'description' => 'The maximum hourly price for pay-as-you-go instances or preemptible instances.', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'Cores' => [ + 'description' => 'The number of vCPUs of the instance type.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size of the instance type. Unit: GiB.', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'InstanceFamilyLevel' => [ + 'description' => 'The level of the instance type, which is used to filter the instance types that meet the specified criteria. This parameter takes effect only if you set the `CostOptimization` parameter to true. Valid values:'."\n" + ."\n" + .'* EntryLevel: shared instance type. Instances of this level are the most cost-effective but may not provide stable computing performance in a consistent manner. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see [Shared instance families](~~108489~~).'."\n" + .'* EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see [Instance family](~~25378~~).'."\n" + .'* CreditEntryLevel: This value is valid only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see the [Overview](~~59977~~) topic of burstable instances.'."\n", + 'type' => 'string', + 'example' => 'EnterpriseLevel', + ], + 'Architectures' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Architecture' => [ + 'description' => 'The architectures of the instance types. Valid values:'."\n" + ."\n" + .'- X86: x86 architecture.'."\n" + .'- Heterogeneous: heterogeneous architecture, such as GPUs and FPGAs.'."\n" + .'- BareMetal: ECS Bare Metal Instance architecture.'."\n" + .'- Arm: ARM architecture.'."\n" + .'- SuperComputeCluster: Super Computing Cluster architecture.', + 'type' => 'array', + 'items' => [ + 'description' => 'The architectures of the instance types. Valid values:'."\n" + ."\n" + .'- X86: x86 architecture.'."\n" + .'- Heterogeneous: heterogeneous architecture, such as GPUs and FPGAs.'."\n" + .'- BareMetal: ECS Bare Metal Instance architecture.'."\n" + .'- Arm: ARM architecture.'."\n" + .'- SuperComputeCluster: Super Computing Cluster architecture.', + 'type' => 'string', + 'example' => 'X86', + ], + ], + ], + ], + 'BurstablePerformance' => [ + 'description' => 'Indicates whether burstable instance types are included. Valid values:'."\n" + ."\n" + .'- Exclude: Burstable instance types are not included.'."\n" + .'- Include: Burstable instance types are included.'."\n" + .'- Required: Only burstable instance types are included.', + 'type' => 'string', + 'example' => 'Include', + ], + 'ExcludedInstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExcludedInstanceType' => [ + 'description' => 'The instance types that are excluded. You can use wildcard characters such as an asterisk (*) to exclude an instance type or an instance family. Examples:'."\n" + ."\n" + .'- ecs.c6.large: The ecs.c6.large instance type is excluded.'."\n" + .'- ecs.c6.*: The c6 instance family is excluded.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance types that are excluded. You can use wildcard characters such as an asterisk (*) to exclude an instance type or an instance family. Examples:'."\n" + ."\n" + .'- ecs.c6.large: The ecs.c6.large instance type is excluded.'."\n" + .'- ecs.c6.*: The c6 instance family is excluded.', + 'type' => 'string', + 'example' => 'ecs.n1.small/ecs.n1.*/*7*', + ], + ], + ], + ], + 'InstanceTypeFamilies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeFamily' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'MinimumCpuCoreCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaximumCpuCoreCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'GpuSpecs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'GpuSpec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'InstanceCategories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceCategory' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'CpuArchitectures' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CpuArchitecture' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PhysicalProcessorModels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PhysicalProcessorModel' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'MinimumEniQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumEniPrivateIpAddressQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumEniIpv6AddressQuantity' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumInitialCredit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumBaselineCredit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MinimumMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'MaximumMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'MinimumGpuAmount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MaximumGpuAmount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + 'SystemDiskCategories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemDiskCategory' => [ + 'description' => 'The categories of the system disks. If Auto Scaling cannot create instances by using the disk whose category has the highest priority, Auto Scaling creates instances by using the disk whose category has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk'."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n" + ."\n" + .'> If you specify SystemDiskCategories, you cannot specify `SystemDisk.Category`.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The categories of the system disks. If Auto Scaling cannot create instances by using the disk whose category has the highest priority, Auto Scaling creates instances by using the disk whose category has the next highest priority. Valid values:'."\n" + ."\n" + .'* cloud: basic disk'."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n" + ."\n" + .'> If you specify SystemDiskCategories, you cannot specify `SystemDisk.Category`.'."\n", + 'type' => 'string', + 'example' => 'cloud', + ], + ], + ], + ], + 'WeightedCapacities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WeightedCapacity' => [ + 'description' => 'The weight of the instance type. The weight of an instance type indicates the capacity of an instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.', + 'type' => 'array', + 'items' => [ + 'description' => 'The weight of the instance type. The weight of an instance type indicates the capacity of an instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.', + 'type' => 'string', + 'example' => '4', + ], + ], + ], + ], + 'InstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceType' => [ + 'description' => 'Details of the ECS instance types.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the ECS instance types.', + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + ], + ], + ], + 'SecurityGroupIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'The IDs of the security groups with which the ECS instance is associated. ECS instances that are associated with the same security group can access each other.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the security groups with which the ECS instance is associated. ECS instances that are associated with the same security group can access each other.', + 'type' => 'string', + 'example' => 'sg-bp18kz60mefs****', + ], + ], + ], + ], + 'SchedulerOptions' => [ + 'description' => '>This parameter is in invitational preview and is unavailable.', + 'type' => 'object', + 'properties' => [ + 'ManagedPrivateSpaceId' => [ + 'description' => '>This parameter is in invitational preview and is unavailable.', + 'type' => 'string', + 'example' => 'testManagedPrivateSpaceId', + ], + ], + ], + 'SystemDisk.Encrypted' => [ + 'description' => 'Indicates whether the system disk is encrypted. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SystemDisk.KMSKeyId' => [ + 'description' => 'The ID of the KMS key that is used to encrypt the system disk.', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'SystemDisk.EncryptAlgorithm' => [ + 'description' => 'The algorithm that is used to encrypt the system disk. Valid values:'."\n" + ."\n" + .'- AES-256'."\n" + .'- SM4-128', + 'type' => 'string', + 'example' => 'AES-256', + ], + 'SystemDisk.ProvisionedIops' => [ + 'description' => 'The provisioned IOPS for the system disk.'."\n" + ."\n" + .'>IOPS measures the number of read and write operations that an EBS device can process per second.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'SystemDisk.BurstingEnabled' => [ + 'description' => 'Indicates whether the burst feature is enabled for the system disk. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'>This parameter is available only if you set the SystemDisk.Category parameter to cloud_auto.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ImageOptions.LoginAsNonRoot' => [ + 'type' => 'boolean', + 'description' => 'For more information about whether an ECS instance uses the ecs-user user user to log on to an ECS instance, see Manage the login name of an ECS instance. Value range:'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No.'."\n" + ."\n" + .'Default value: false.', + 'example' => 'false', + ], + 'DeletionProtection' => [ + 'type' => 'boolean', + ], + 'StorageSetId' => [ + 'type' => 'string', + ], + 'StorageSetPartitionNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CustomPriorities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomPriority' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'VswitchId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'NetworkInterfaces' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetworkInterface' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + 'NetworkInterfaceTrafficMode' => [ + 'type' => 'string', + ], + 'Ipv6AddressCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SecurityGroupIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityGroupId' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SecondaryPrivateIpAddressCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + 'DedicatedHostClusterId' => [ + 'type' => 'string', + ], + 'PasswordSetted' => [ + 'type' => 'boolean', + ], + 'SecurityOptions' => [ + 'type' => 'object', + 'properties' => [ + 'ConfidentialComputingMode' => [ + 'type' => 'string', + ], + ], + ], + 'HttpEndpoint' => [ + 'type' => 'string', + ], + 'HttpTokens' => [ + 'type' => 'string', + ], + 'ResourcePoolOptions' => [ + 'type' => 'object', + 'properties' => [ + 'Strategy' => [ + 'type' => 'string', + ], + 'PrivatePoolIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PrivatePoolId' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 1,\\n \\"ScalingConfigurations\\": {\\n \\"ScalingConfiguration\\": [\\n {\\n \\"DeploymentSetId\\": \\"ds-bp1frxuzdg87zh4p****\\",\\n \\"CreationTime\\": \\"2014-08-14T10:58Z\\",\\n \\"ScalingConfigurationName\\": \\"scalingconfigura****\\",\\n \\"SystemDiskDescription\\": \\"Test system disk.\\",\\n \\"KeyPairName\\": \\"keypair****\\",\\n \\"SecurityGroupId\\": \\"sg-bp18kz60mefs****\\",\\n \\"PrivatePoolOptions.Id\\": \\"eap-bp67acfmxazb4****\\",\\n \\"SystemDiskAutoSnapshotPolicyId\\": \\"sp-bp12m37ccmxvbmi5****\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"ScalingGroupId\\": \\"asg-bp17pelvl720x3v7****\\",\\n \\"Affinity\\": \\"default\\",\\n \\"Tenancy\\": \\"default\\",\\n \\"SystemDiskSize\\": 100,\\n \\"Ipv6AddressCount\\": 1,\\n \\"SpotDuration\\": 1,\\n \\"LifecycleState\\": \\"Active\\",\\n \\"InstanceName\\": \\"instance****\\",\\n \\"SecurityEnhancementStrategy\\": \\"Active\\",\\n \\"UserData\\": \\"echo hello ecs!\\",\\n \\"PrivatePoolOptions.MatchCriteria\\": \\"Open\\",\\n \\"DedicatedHostId\\": \\"dh-bp67acfmxazb4p****\\",\\n \\"InstanceGeneration\\": \\"ecs-3\\",\\n \\"HpcClusterId\\": \\"hpc-clus****\\",\\n \\"PasswordInherit\\": true,\\n \\"Memory\\": 16,\\n \\"ImageId\\": \\"centos6u5_64_20G_aliaegis_2014****.vhd\\",\\n \\"ImageFamily\\": \\"hangzhou-daily-update\\",\\n \\"ImageOwnerAlias\\": \\"system\\",\\n \\"LoadBalancerWeight\\": 1,\\n \\"SystemDiskCategory\\": \\"cloud\\",\\n \\"HostName\\": \\"LocalHost\\",\\n \\"SystemDiskName\\": \\"cloud_ssd_Test\\",\\n \\"InternetMaxBandwidthOut\\": 10,\\n \\"InternetMaxBandwidthIn\\": 10,\\n \\"InstanceType\\": \\"ecs.g6.large\\",\\n \\"InstanceDescription\\": \\"FinanceDept\\",\\n \\"IoOptimized\\": \\"none\\",\\n \\"RamRoleName\\": \\"ramrole****\\",\\n \\"SystemDiskPerformanceLevel\\": \\"PL1\\",\\n \\"Cpu\\": 2,\\n \\"ResourceGroupId\\": \\"rg-aekzn2ou7xo****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"ImageName\\": \\"centos6u5_64_20G_aliaegis_20140703.vhd\\",\\n \\"ScalingConfigurationId\\": \\"asc-bp1ezrfgoyn5kijl****\\",\\n \\"CreditSpecification\\": \\"Standard\\",\\n \\"SpotInterruptionBehavior\\": \\"Terminate\\",\\n \\"DataDisks\\": {\\n \\"DataDisk\\": [\\n {\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"Description\\": \\"FinanceDept\\",\\n \\"SnapshotId\\": \\"s-23f2i****\\",\\n \\"Device\\": \\"/dev/xvdb\\",\\n \\"Size\\": 200,\\n \\"DiskName\\": \\"cloud_ssdData\\",\\n \\"AutoSnapshotPolicyId\\": \\"sp-bp19nq9enxqkomib****\\",\\n \\"Category\\": \\"cloud\\",\\n \\"KMSKeyId\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"DeleteWithInstance\\": true,\\n \\"Encrypted\\": \\"false\\",\\n \\"Categories\\": {\\n \\"Category\\": [\\n \\"cloud_essd\\"\\n ]\\n },\\n \\"ProvisionedIops\\": 100,\\n \\"BurstingEnabled\\": false\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"binary\\",\\n \\"Value\\": \\"alterTable\\"\\n }\\n ]\\n },\\n \\"SpotPriceLimit\\": {\\n \\"SpotPriceModel\\": [\\n {\\n \\"InstanceType\\": \\"ecs.g6.large\\",\\n \\"PriceLimit\\": 0.125\\n }\\n ]\\n },\\n \\"InstancePatternInfos\\": {\\n \\"InstancePatternInfo\\": [\\n {\\n \\"MaxPrice\\": 2,\\n \\"Cores\\": 2,\\n \\"Memory\\": 4,\\n \\"InstanceFamilyLevel\\": \\"EnterpriseLevel\\",\\n \\"Architectures\\": {\\n \\"Architecture\\": [\\n \\"X86\\"\\n ]\\n },\\n \\"BurstablePerformance\\": \\"Include\\",\\n \\"ExcludedInstanceTypes\\": {\\n \\"ExcludedInstanceType\\": [\\n \\"ecs.n1.small/ecs.n1.*/*7*\\"\\n ]\\n },\\n \\"InstanceTypeFamilies\\": {\\n \\"InstanceTypeFamily\\": [\\n \\"ecs.g6\\"\\n ]\\n },\\n \\"MinimumCpuCoreCount\\": 2,\\n \\"MaximumCpuCoreCount\\": 4,\\n \\"GpuSpecs\\": {\\n \\"GpuSpec\\": [\\n \\"NVIDIA V100\\"\\n ]\\n },\\n \\"InstanceCategories\\": {\\n \\"InstanceCategory\\": [\\n \\"Compute-optimized with GPU\\"\\n ]\\n },\\n \\"CpuArchitectures\\": {\\n \\"CpuArchitecture\\": [\\n \\"X86\\"\\n ]\\n },\\n \\"PhysicalProcessorModels\\": {\\n \\"PhysicalProcessorModel\\": [\\n \\"Intel Xeon(Ice Lake) Platinum 8369B\\\\\\", \\\\\\"Intel Xeon(Skylake) Platinum 8163\\\\\\", … \\\\\\"Intel Xeon(Cascade Lake) Platinum 8269CY\\"\\n ]\\n },\\n \\"MinimumEniQuantity\\": 2,\\n \\"MinimumEniPrivateIpAddressQuantity\\": 2,\\n \\"MinimumEniIpv6AddressQuantity\\": 1,\\n \\"MinimumInitialCredit\\": 12,\\n \\"MinimumBaselineCredit\\": 12,\\n \\"MinimumMemorySize\\": 4,\\n \\"MaximumMemorySize\\": 4,\\n \\"MinimumGpuAmount\\": 2,\\n \\"MaximumGpuAmount\\": 2\\n }\\n ]\\n },\\n \\"SystemDiskCategories\\": {\\n \\"SystemDiskCategory\\": [\\n \\"cloud\\"\\n ]\\n },\\n \\"WeightedCapacities\\": {\\n \\"WeightedCapacity\\": [\\n \\"4\\"\\n ]\\n },\\n \\"InstanceTypes\\": {\\n \\"InstanceType\\": [\\n \\"ecs.g6.large\\"\\n ]\\n },\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-bp18kz60mefs****\\"\\n ]\\n },\\n \\"SchedulerOptions\\": {\\n \\"ManagedPrivateSpaceId\\": \\"testManagedPrivateSpaceId\\"\\n },\\n \\"SystemDisk.Encrypted\\": false,\\n \\"SystemDisk.KMSKeyId\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"SystemDisk.EncryptAlgorithm\\": \\"AES-256\\",\\n \\"SystemDisk.ProvisionedIops\\": 100,\\n \\"SystemDisk.BurstingEnabled\\": false,\\n \\"ImageOptions.LoginAsNonRoot\\": false,\\n \\"DeletionProtection\\": false,\\n \\"StorageSetId\\": \\"ss-bp67acfmxazb4p****\\",\\n \\"StorageSetPartitionNumber\\": 2,\\n \\"CustomPriorities\\": {\\n \\"CustomPriority\\": [\\n {\\n \\"InstanceType\\": \\"ecs.g6.large\\",\\n \\"VswitchId\\": \\"vsw-bp14zolna43z266bq****\\"\\n }\\n ]\\n },\\n \\"NetworkInterfaces\\": {\\n \\"NetworkInterface\\": [\\n {\\n \\"InstanceType\\": \\"Primary\\",\\n \\"NetworkInterfaceTrafficMode\\": \\"HighPerformance\\",\\n \\"Ipv6AddressCount\\": 1,\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-2vc3e1v7h****\\"\\n ]\\n },\\n \\"SecondaryPrivateIpAddressCount\\": 2\\n }\\n ]\\n },\\n \\"DedicatedHostClusterId\\": \\"dc-2zedxc67zqzt7lb4****\\",\\n \\"PasswordSetted\\": false,\\n \\"SecurityOptions\\": {\\n \\"ConfidentialComputingMode\\": \\"TDX\\"\\n },\\n \\"HttpEndpoint\\": \\"enabled\\",\\n \\"HttpTokens\\": \\"optional\\",\\n \\"ResourcePoolOptions\\": {\\n \\"Strategy\\": \\"PrivatePoolFirst\\",\\n \\"PrivatePoolIds\\": {\\n \\"PrivatePoolId\\": [\\n \\"eap-bp67acfmxazb4****\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeScalingConfigurationsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>50</PageSize>\\n <TotalCount>1</TotalCount>\\n <ScalingConfigurations>\\n <DeploymentSetId>ds-bp1frxuzdg87zh4p****</DeploymentSetId>\\n <CreationTime>2014-08-14T10:58Z</CreationTime>\\n <ScalingConfigurationName>scalingconfigura****</ScalingConfigurationName>\\n <SystemDiskDescription>Test system disk.</SystemDiskDescription>\\n <KeyPairName>keypair****</KeyPairName>\\n <SecurityGroupId>sg-bp18kz60mefs****</SecurityGroupId>\\n <PrivatePoolOptions.Id>eap-bp67acfmxazb4****</PrivatePoolOptions.Id>\\n <SystemDiskAutoSnapshotPolicyId>sp-bp12m37ccmxvbmi5****</SystemDiskAutoSnapshotPolicyId>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n <ScalingGroupId>asg-bp17pelvl720x3v7****</ScalingGroupId>\\n <Affinity>default</Affinity>\\n <Tenancy>default</Tenancy>\\n <SystemDiskSize>100</SystemDiskSize>\\n <Ipv6AddressCount>1</Ipv6AddressCount>\\n <SpotDuration>1</SpotDuration>\\n <LifecycleState>Active</LifecycleState>\\n <InstanceName>instance****</InstanceName>\\n <SecurityEnhancementStrategy>Active</SecurityEnhancementStrategy>\\n <UserData>echo hello ecs!</UserData>\\n <PrivatePoolOptions.MatchCriteria>Open</PrivatePoolOptions.MatchCriteria>\\n <DedicatedHostId>dh-bp67acfmxazb4p****</DedicatedHostId>\\n <InstanceGeneration>ecs-3</InstanceGeneration>\\n <HpcClusterId>hpc-clus****</HpcClusterId>\\n <PasswordInherit>true</PasswordInherit>\\n <Memory>16</Memory>\\n <ImageId>centos6u5_64_20G_aliaegis_2014****.vhd</ImageId>\\n <ImageFamily>hangzhou-daily-update</ImageFamily>\\n <ImageOwnerAlias>system</ImageOwnerAlias>\\n <LoadBalancerWeight>1</LoadBalancerWeight>\\n <SystemDiskCategory>cloud</SystemDiskCategory>\\n <HostName>LocalHost</HostName>\\n <SystemDiskName>cloud_ssd_Test</SystemDiskName>\\n <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>\\n <InternetMaxBandwidthIn>200</InternetMaxBandwidthIn>\\n <InstanceType>ecs.g6.large</InstanceType>\\n <InstanceDescription>FinanceDept</InstanceDescription>\\n <IoOptimized>none</IoOptimized>\\n <RamRoleName>ramrole****</RamRoleName>\\n <SystemDiskPerformanceLevel>PL1</SystemDiskPerformanceLevel>\\n <Cpu>2</Cpu>\\n <ResourceGroupId>rg-aekzn2ou7xo****</ResourceGroupId>\\n <ZoneId>cn-hangzhou-g</ZoneId>\\n <InternetChargeType>PayByTraffic</InternetChargeType>\\n <ImageName>centos6u5_64_20G_aliaegis_20140703.vhd</ImageName>\\n <ScalingConfigurationId>asc-bp1ezrfgoyn5kijl****</ScalingConfigurationId>\\n <CreditSpecification>Standard</CreditSpecification>\\n <SpotInterruptionBehavior>Terminate</SpotInterruptionBehavior>\\n <DataDisks>\\n <PerformanceLevel>PL1</PerformanceLevel>\\n <Description>FinanceDept</Description>\\n <SnapshotId>s-23f2i****</SnapshotId>\\n <Device>/dev/xvdb</Device>\\n <Size>200</Size>\\n <DiskName>cloud_ssdData</DiskName>\\n <AutoSnapshotPolicyId>sp-bp19nq9enxqkomib****</AutoSnapshotPolicyId>\\n <Category>cloud</Category>\\n <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>\\n <DeleteWithInstance>true</DeleteWithInstance>\\n <Encrypted>false</Encrypted>\\n <Categories>cloud_essd</Categories>\\n <ProvisionedIops>100</ProvisionedIops>\\n <BurstingEnabled>false</BurstingEnabled>\\n </DataDisks>\\n <Tags>\\n <Key>binary</Key>\\n <Value>alterTable</Value>\\n </Tags>\\n <SpotPriceLimit>\\n <InstanceType>ecs.g6.large</InstanceType>\\n <PriceLimit>0.125</PriceLimit>\\n </SpotPriceLimit>\\n <InstancePatternInfos>\\n <MaxPrice>2</MaxPrice>\\n <Cores>2</Cores>\\n <Memory>4</Memory>\\n <InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>\\n <Architectures>X86</Architectures>\\n <BurstablePerformance>Include</BurstablePerformance>\\n <ExcludedInstanceTypes>ecs.n1.small/ecs.n1.*/*7*</ExcludedInstanceTypes>\\n <InstanceTypeFamilies>[\\"ecs.g6\\", \\"ecs.c6\\", … \\"ecs.r6\\"]</InstanceTypeFamilies>\\n <MinimumCpuCoreCount>2</MinimumCpuCoreCount>\\n <MaximumCpuCoreCount>4</MaximumCpuCoreCount>\\n <GpuSpecs>[\\"NVIDIA V100\\"]</GpuSpecs>\\n <InstanceCategories>[\\"Compute-optimized with GPU\\"]</InstanceCategories>\\n <CpuArchitectures>[\\"X86\\", \\"ARM\\"]</CpuArchitectures>\\n <PhysicalProcessorModels>[\\"Intel Xeon(Ice Lake) Platinum 8369B\\", \\"Intel Xeon(Skylake) Platinum 8163\\", … \\"Intel Xeon(Cascade Lake) Platinum 8269CY\\"]</PhysicalProcessorModels>\\n <MinimumEniQuantity>2</MinimumEniQuantity>\\n <MinimumEniPrivateIpAddressQuantity>2</MinimumEniPrivateIpAddressQuantity>\\n <MinimumEniIpv6AddressQuantity>1</MinimumEniIpv6AddressQuantity>\\n <MinimumInitialCredit>12</MinimumInitialCredit>\\n <MinimumBaselineCredit>12</MinimumBaselineCredit>\\n <MinimumMemorySize>4</MinimumMemorySize>\\n <MaximumMemorySize>4</MaximumMemorySize>\\n <MinimumGpuAmount>2</MinimumGpuAmount>\\n <MaximumGpuAmount>2</MaximumGpuAmount>\\n </InstancePatternInfos>\\n <SystemDiskCategories>cloud</SystemDiskCategories>\\n <WeightedCapacities>4</WeightedCapacities>\\n <InstanceTypes>ecs.g6.large</InstanceTypes>\\n <SecurityGroupIds>sg-bp18kz60mefs****</SecurityGroupIds>\\n <SchedulerOptions>\\n <ManagedPrivateSpaceId>testManagedPrivateSpaceId</ManagedPrivateSpaceId>\\n </SchedulerOptions>\\n <SystemDisk.Encrypted>false</SystemDisk.Encrypted>\\n <SystemDisk.KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</SystemDisk.KMSKeyId>\\n <SystemDisk.EncryptAlgorithm>AES-256</SystemDisk.EncryptAlgorithm>\\n <SystemDisk.ProvisionedIops>100</SystemDisk.ProvisionedIops>\\n <SystemDisk.BurstingEnabled>false</SystemDisk.BurstingEnabled>\\n <ImageOptions.LoginAsNonRoot>false</ImageOptions.LoginAsNonRoot>\\n <DeletionProtection>false</DeletionProtection>\\n <StorageSetId>ss-bp67acfmxazb4p****</StorageSetId>\\n <StorageSetPartitionNumber>2</StorageSetPartitionNumber>\\n <CustomPriorities>\\n <InstanceType>ecs.g6.large</InstanceType>\\n <VswitchId>vsw-bp14zolna43z266bq****</VswitchId>\\n </CustomPriorities>\\n <NetworkInterfaces>\\n <InstanceType>Primary</InstanceType>\\n <NetworkInterfaceTrafficMode>HighPerformance</NetworkInterfaceTrafficMode>\\n <Ipv6AddressCount>1</Ipv6AddressCount>\\n <SecurityGroupIds>sg-2vc3e1v7h****</SecurityGroupIds>\\n </NetworkInterfaces>\\n <DedicatedHostClusterId>dc-2zedxc67zqzt7lb4****</DedicatedHostClusterId>\\n </ScalingConfigurations>\\n</DescribeScalingConfigurationsResponse>","errorExample":""}]', + 'title' => 'DescribeScalingConfigurations', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeScalingConfigurations\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeactivateScalingConfiguration' => [ + 'summary' => '使指定伸缩配置进入失效状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92661', + 'abilityTreeNodes' => [ + 'FEATUREessT4M3WE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asc-bp1ahp2ud7qkzt2a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D09C9E64-7D19-4E1C-8CD6-123D34A4****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D09C9E64-7D19-4E1C-8CD6-123D34A4****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeactivateScalingConfigurationResponse>\\r\\n <RequestId>D09C9E64-7D19-4E1C-8CD6-123D34A4****</RequestId>\\r\\n</DeactivateScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'DeactivateScalingConfiguration', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DeactivateScalingConfiguration\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CreateScalingRule' => [ + 'summary' => '创建一条伸缩规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92659', + 'abilityTreeNodes' => [ + 'FEATUREessRTZKQT', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group for which you want to create the scaling rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1ffogfdauy0jw0****', + ], + ], + [ + 'name' => 'ScalingRuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling rule. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n" + ."\n" + .'The name of a scaling rule must be unique within an Alibaba Cloud account in a region.'."\n" + ."\n" + .'> If you leave this parameter empty, the scaling rule ID is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalingrule****', + ], + ], + [ + 'name' => 'Cooldown', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cooldown period of the scaling rule. This parameter is available only if you set **ScalingRuleType** to **SimpleScalingRule**. Valid values: 0 to 86400. Unit: seconds.'."\n" + ."\n" + .'You can leave this parameter empty.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'MinAdjustmentMagnitude', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of instances that must be scaled. This parameter takes effect if you set `ScalingRuleType` to `SimpleScalingRule` or `StepScalingRule`, and `AdjustmentType` to **PercentChangeInCapacity**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AdjustmentType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The adjustment method of the scaling rule. If you set **ScalingRuleType** to **SimpleScalingRule** or **StepScalingRule**, you must specify this parameter. Valid values:'."\n" + ."\n" + .'* QuantityChangeInCapacity: adds the specified number of ECS instances to or removes the specified number of ECS instances from the scaling group.'."\n" + .'* PercentChangeInCapacity: adds the specified percentage of ECS instances to or removes the specified percentage of ECS instances from the scaling group.'."\n" + .'* TotalCapacity: adjusts the number of ECS instances in the scaling group to a specified number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'QuantityChangeInCapacity', + ], + ], + [ + 'name' => 'AdjustmentValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instances that must be scaled based on the scaling rule. If you set **ScalingRuleType** to **SimpleScalingRule** or **StepScalingRule**, you must specify this parameter. The number of ECS instances that must be scaled in a scaling activity cannot exceed 1,000. Valid values of **AdjustmentValue** vary based on the value of **AdjustmentTyp****e**.'."\n" + ."\n" + .'* Valid values if **AdjustmentType** is set to **QuantityChangeInCapacity**: -1000 to 1000.'."\n" + .'* Valid values if **AdjustmentType** is set to **PercentChangeInCapacity**: -100 to 10000.'."\n" + .'* Valid values if **AdjustmentType** is set to **TotalCapacity**: 0 to 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ScalingRuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the scaling rule. Valid values:'."\n" + ."\n" + .'* SimpleScalingRule: scales the number of ECS instances based on the values of **AdjustmentType** and **AdjustmentValue**.'."\n" + .'* TargetTrackingScalingRule: calculates the number of ECS instances that must be scaled and maintains the value of a predefined metric close to the value of **TargetValue**.'."\n" + .'* StepScalingRule: scales ECS instances in steps based on the specified thresholds and metric values.'."\n" + .'* PredictiveScalingRule: uses machine learning to analyze historical monitoring data of the scaling group and predicts the future values of metrics. In addition, Auto Scaling automatically creates scheduled tasks to specify the value range for the scaling group.'."\n" + ."\n" + .'Default value: SimpleScalingRule'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SimpleScalingRule', + 'default' => 'SimpleScalingRule', + ], + ], + [ + 'name' => 'EstimatedInstanceWarmup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The warmup period of an ECS instance. This parameter is available only if you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**. Auto Scaling adds ECS instances that are in the Warmup state to a scaling group, but does not report monitoring data of the ECS instances to CloudMonitor during the warmup period.'."\n" + ."\n" + .'> When Auto Scaling calculates the number of ECS instances that must be scaled, ECS instances in the Warmup state are not counted toward the current capacity of the scaling group.'."\n" + ."\n" + .'Valid values: 0 to 86400. Unit: seconds.'."\n" + ."\n" + .'Default value: 300'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The predefined metric of the scaling rule. If you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**, you must also specify this parameter.'."\n" + ."\n" + .'Valid values if **ScalingRuleType** is set to **TargetTrackingScalingRule**:'."\n" + ."\n" + .'* CpuUtilization: the average CPU utilization'."\n" + .'* ClassicInternetRx: the average inbound Internet traffic over the classic network'."\n" + .'* ClassicInternetTx: the average outbound Internet traffic over the classic network'."\n" + .'* VpcInternetRx: the average inbound Internet traffic over a virtual private cloud (VPC)'."\n" + .'* VpcInternetTx: the average outbound Internet traffic over a VPC'."\n" + .'* IntranetRx: the average inbound traffic over the internal network'."\n" + .'* IntranetTx: the average outbound traffic over the internal network'."\n" + ."\n" + .'Valid values if **ScalingRuleType** is set to **PredictiveScalingRule**:'."\n" + ."\n" + .'* CpuUtilization: the average CPU utilization'."\n" + .'* IntranetRx: the average inbound traffic over the internal network'."\n" + .'* IntranetTx: the average outbound traffic over the internal network'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUtilization', + ], + ], + [ + 'name' => 'TargetValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The target value. If you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**, you must also specify this parameter. The value must be greater than 0 and can contain up to three decimal places.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.125', + ], + ], + [ + 'name' => 'DisableScaleIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to disable scale-in. This parameter is available if you set **ScalingRuleType** to **TargetTrackingScalingRule**.'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ScaleInEvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of consecutive times that the event-triggered task created for scale-ins must meet the threshold conditions before an alert is triggered. After a target tracking scaling rule is created, an event-triggered task is automatically created and associated with the target tracking scaling rule.'."\n" + ."\n" + .'Default value: 15'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + ], + [ + 'name' => 'ScaleOutEvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of consecutive times that the event-triggered task created for scale-outs must meet the threshold conditions before an alert is triggered. After a target tracking scaling rule is created, an event-triggered task is automatically created and associated with the target tracking scaling rule.'."\n" + ."\n" + .'Default value: 3'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'PredictiveScalingMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the predictive scaling rule. Valid values:'."\n" + ."\n" + .'* PredictAndScale: provides predictions and creates prediction tasks.'."\n" + .'* PredictOnly: provides predictions but does not create prediction tasks.'."\n" + ."\n" + .'Default value: PredictAndScale'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PredictAndScale', + ], + ], + [ + 'name' => 'PredictiveValueBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action on the predicted maximum value. Valid values:'."\n" + ."\n" + .'* MaxOverridePredictiveValue: uses the initial maximum capacity as the maximum value for prediction tasks if the predicted value is greater than the initial maximum capacity.'."\n" + .'* PredictiveValueOverrideMax: uses the predicted value as the maximum value for prediction tasks if the predicted value is greater than the initial maximum capacity.'."\n" + .'* PredictiveValueOverrideMaxWithBuffer: increases the predicted value by a ratio that is specified by **PredictiveValueBuffer**, and uses the increased value as the maximum value for prediction tasks if the predicted value increased by the ratio is greater than the initial maximum capacity.'."\n" + ."\n" + .'Default value: MaxOverridePredictiveValue'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxOverridePredictiveValue', + ], + ], + [ + 'name' => 'PredictiveValueBuffer', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ratio based on which the predicted value is increased if you set **PredictiveValueBehavior** to **PredictiveValueOverrideMaxWithBuffer**. If the predicted value increased by this ratio is greater than the initial maximum capacity, the increased value is used as the maximum value for prediction tasks. Valid values: 0 to 100.'."\n" + ."\n" + .'Default value: 0'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PredictiveTaskBufferTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount of buffer time before the prediction task runs. By default, all prediction tasks that are automatically created by a predictive scaling rule run on the hour. You can specify a buffer time to run prediction tasks and prepare resources in advance. Valid values: 0 to 60. Unit: minutes.'."\n" + ."\n" + .'Default value: 0'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'InitialMaxSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of ECS instances that can be added to the scaling group. If you specify **InitialMaxSize**, you must also specify **PredictiveValueBehavior**.'."\n" + ."\n" + .'The default value of this parameter is the value of **MaxSize**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'StepAdjustment', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the step adjustments.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricIntervalUpperBound' => [ + 'description' => 'The upper limit of a step adjustment. This parameter takes effect only if you set **ScalingRuleType** to **StepScalingRule**. Valid values: -9.999999E18 to 9.999999E18.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '5.0', + ], + 'ScalingAdjustment' => [ + 'description' => 'The number of ECS instances that you want to scale in each step adjustment. This parameter is available if you set **ScalingRuleType** to **StepScalingRule**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'MetricIntervalLowerBound' => [ + 'description' => 'The lower limit of a step adjustment. This parameter is available if you set **ScalingRuleType** to **StepScalingRule**. Valid values: -9.999999E18 to 9.999999E18.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + 'required' => false, + 'description' => 'The upper limit that is specified in a step adjustment. Valid values: -9.999999E18 to 9.999999E18.', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlarmDimension', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The dimension key of the metric.'."\n", + 'example' => 'rulePool', + ], + 'DimensionValue' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The dimension value of the metric.'."\n", + 'example' => 'sgp-j4zhc14afvtg9khq8o', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + 'description' => 'The dimension information associated with the item is applicable to the target tracking rule and is set when the item requires additional dimension information, for example, the `LoadBalancerRealServerAverageQps` item needs to specify the `rulePool` dimension information.', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HybridMonitorNamespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HybridMetrics', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'Statistic' => [ + 'type' => 'string', + ], + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + ], + 'DimensionValue' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 10, + ], + ], + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AlarmOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Period' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingRuleAri' => [ + 'description' => 'The unique identifier of the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'ScalingRuleId' => [ + 'description' => 'The ID of the scaling rule, which is generated by the system and is globally unique.'."\n", + 'type' => 'string', + 'example' => 'asr-bp1dvirgwkoowxk7****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingRuleAri\\": \\"ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ScalingRuleId\\": \\"asr-bp1dvirgwkoowxk7****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScalingRuleResponse>\\n <ScalingRuleAri>ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****</ScalingRuleAri>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ScalingRuleId>asr-bp1dvirgwkoowxk7****</ScalingRuleId>\\n</CreateScalingRuleResponse>","errorExample":""}]', + 'title' => 'CreateScalingRule', + 'description' => '## Usage notes'."\n" + ."\n" + .'A scaling rule specifies a specific scaling action, such as adding or removing *N* Elastic Compute Service (ECS) instances. If the number of ECS instances in a scaling group is less than the minimum number allowed or greater than the maximum number allowed after a scaling rule is executed, Auto Scaling adjusts the number of ECS instances to ensure that the number of ECS instances is still within the valid range after the scaling rule is executed. Examples:'."\n" + ."\n" + .'* If your scaling group contains two ECS instances and allows up to three ECS instances, only one ECS instance is added to your scaling group after you execute a scale-out rule in which three ECS instances are specified.'."\n" + .'* If your scaling group contains three ECS instances and requires at least two ECS instances, only one ECS instance is removed from your scaling group after you execute a scale-in rule in which five ECS instances are specified.'."\n" + ."\n" + .'Before you call this operation, take note of the following items:'."\n" + ."\n" + .'* If you set **AdjustmentType** to **TotalCapacity**, the number of ECS instances in the scaling group is adjusted to a specified value. The value of **AdjustmentValue** must be greater than or equal to 0.'."\n" + ."\n" + .'* If you set **AdjustmentType** to **QuantityChangeInCapacity**, a positive value of **AdjustmentValue** specifies the number of ECS instances that are added to the scaling group, and a negative value specifies the number of ECS instances that are removed from the scaling group.'."\n" + ."\n" + .'* If you set **AdjustmentType** to **PercentChangeInCapacity**, Auto Scaling calculates a value by using the following formula, and then rounds the value to the nearest integer to obtain the number of ECS instances that must be scaled: Value of **TotalCapacity** × Value of **AdjustmentValue**/100.'."\n" + ."\n" + .'* If you specify a cooldown period for a scaling rule, the cooldown period of the scaling rule takes effect after you execute the scaling rule. If you do not specify a cooldown period for a scaling rule, the value of **DefaultCooldown** of the scaling group takes effect after you execute the scaling rule.'."\n" + ."\n" + .'* You can create only a limited number of scaling rules for a scaling group. For more information, see [Limits](~~25863~~).'."\n" + ."\n" + .'* The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned by the CreateScalingRule operation:'."\n" + ."\n" + .' * ExecuteScalingRule: You can call this operation to manually execute a scaling rule. In this operation, you can set **ScalingRuleAri** to the unique identifier of the scaling rule that you want to execute.'."\n" + .' * CreateScheduledTask: You can call this operation to create a scheduled task for a scaling rule. In this operation, you can set **ScalingRuleAri** to the unique identifier of the scaling rule for which you want to create a scheduled task.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteScalingRule' => [ + 'summary' => '删除一条伸缩规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92668', + 'abilityTreeNodes' => [ + 'FEATUREessRTZKQT', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling rule that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asr-bp163l21e07uhnyt****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScalingRuleResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DeleteScalingRuleResponse>","errorExample":""}]', + 'title' => 'DeleteScalingRule', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DeleteScalingRule\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyScalingRule' => [ + 'summary' => '修改一条伸缩规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92710', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling rule that you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asr-bp1dvirgwkoowxk7****', + ], + ], + [ + 'name' => 'ScalingRuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling rule. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit. The name of a scaling rule must be unique within an Alibaba Cloud account in a region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalingrule****', + ], + ], + [ + 'name' => 'Cooldown', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cooldown period of the scaling rule. This parameter is available only if you set **ScalingRuleType** to **SimpleScalingRule**.'."\n" + ."\n" + .'Valid values: 0 to 86400. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'MinAdjustmentMagnitude', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of instances that must be scaled. This parameter takes effect only when `ScalingRuleType` is set to `SimpleScalingRule` or `StepScalingRule` and **AdjustmentType** is set to `PercentChangeInCapacity`.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AdjustmentType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The adjustment method of the scaling rule. If you set **ScalingRuleType** to **SimpleScalingRule** or **StepScalingRule**, you must specify this parameter. Valid values:'."\n" + ."\n" + .'* QuantityChangeInCapacity: adds the specified number of Elastic Compute Service (ECS) instances to or removes the specified number of ECS instances from the scaling group.'."\n" + .'* PercentChangeInCapacity: adds the specified percentage of ECS instances to or removes the specified percentage of ECS instances from the scaling group.'."\n" + .'* TotalCapacity: adjusts the number of ECS instances in the scaling group to a specified number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'QuantityChangeInCapacity', + ], + ], + [ + 'name' => 'AdjustmentValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instances that must be scaled based on the scaling rule. If you set **ScalingRuleType** to **SimpleScalingRule** or **StepScalingRule**, you must specify this parameter. The number of ECS instances to be scaled in a single scaling activity cannot exceed 1,000. Valid values of **AdjustmentValue** vary based on the value of **AdjustmentType**.'."\n" + ."\n" + .'* Valid values of **AdjustmentValue** when **AdjustmentType** is set to **QuantityChangeInCapacity**: -1000 to 1000.'."\n" + .'* Valid values of **AdjustmentValue** when **AdjustmentType** is set to **PercentChangeInCapacity**: -100 to 10000.'."\n" + .'* Valid values of **AdjustmentValue** when **AdjustmentType** is set to **TotalCapacity**: 0 to 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'EstimatedInstanceWarmup', + 'in' => 'query', + 'schema' => [ + 'description' => 'The warmup period of an ECS instance. This parameter is available only if you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**. Auto Scaling adds ECS instances that are in the Warmup state to a scaling group but does not report monitoring data of the ECS instances to CloudMonitor during the warmup period.'."\n" + ."\n" + .'> When Auto Scaling calculates the number of ECS instances that you want to scale, the ECS instances that are in the Warmup state are not counted towards the current capacity of the scaling group.'."\n" + ."\n" + .'Valid values: 0 to 86400. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The predefined metric that you want to monitor. If you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**, you must specify this parameter.'."\n" + ."\n" + .'Valid values of **MetricName** when** ScalingRuleType** is set to **TargetTrackingScalingRule**:'."\n" + ."\n" + .'* CpuUtilization: the average CPU utilization'."\n" + .'* ClassicInternetRx: the average inbound Internet traffic over the classic network'."\n" + .'* ClassicInternetTx: the average outbound Internet traffic over the classic network'."\n" + .'* VpcInternetRx: the average inbound Internet traffic over a virtual private cloud (VPC)'."\n" + .'* VpcInternetTx: the average outbound Internet traffic over a VPC'."\n" + .'* IntranetRx: the average inbound traffic over the internal network'."\n" + .'* IntranetTx: the average outbound traffic over the internal network'."\n" + ."\n" + .'Valid values of **MetricName** when **ScalingRuleType** is set to **PredictiveScalingRule**:'."\n" + ."\n" + .'* CpuUtilization: the average CPU utilization'."\n" + .'* IntranetRx: the average inbound traffic over the internal network'."\n" + .'* IntranetTx: the average outbound traffic over the internal network'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUtilization', + ], + ], + [ + 'name' => 'TargetValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The target value. This parameter is available only if you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**. The value must be greater than 0 and can contain up to three decimal places.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.125', + ], + ], + [ + 'name' => 'DisableScaleIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to disable scale-in. This parameter is available only if you set **ScalingRuleType** to **TargetTrackingScalingRule**.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ScaleInEvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of consecutive times that the event-triggered task created for scale-ins meets the threshold conditions before an alert is triggered. After a target tracking scaling rule is created, an event-triggered task is automatically created and associated with the target tracking scaling rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + ], + [ + 'name' => 'ScaleOutEvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of consecutive times that the event-triggered task created for scale-outs meets the threshold conditions before an alert is triggered. After a target tracking scaling rule is created, an event-triggered task is automatically created and associated with the target tracking scaling rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'PredictiveScalingMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode of the predictive scaling rule. Valid values:'."\n" + ."\n" + .'* PredictAndScale: provides predictions and creates prediction tasks.'."\n" + .'* PredictOnly: provides predictions but does not create prediction tasks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PredictAndScale', + ], + ], + [ + 'name' => 'PredictiveValueBehavior', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action on the predicted maximum value. Valid values:'."\n" + ."\n" + .'* MaxOverridePredictiveValue: uses the initial maximum capacity as the maximum value for prediction tasks if the predicted value is greater than the initial maximum capacity.'."\n" + .'* PredictiveValueOverrideMax: uses the predicted value as the maximum value for prediction tasks if the predicted value is greater than the initial maximum capacity.'."\n" + .'* PredictiveValueOverrideMaxWithBuffer: increases the predicted value by a ratio that is specified by **PredictiveValueBuffer**, and uses the increased value as the maximum value for prediction tasks if the predicted value increased by this ratio is greater than the initial maximum capacity.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxOverridePredictiveValue', + ], + ], + [ + 'name' => 'PredictiveValueBuffer', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ratio based on which the predicted value is increased when **PredictiveValueBehavior** is set to **PredictiveValueOverrideMaxWithBuffer**. If the predicted value increased by this ratio is greater than the initial maximum capacity, the increased value is used as the maximum value for prediction tasks. Valid values: 0 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PredictiveTaskBufferTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount of buffer time before the prediction task is executed. By default, all prediction tasks that are automatically created by a predictive scaling rule are executed on the hour. You can set a buffer time to execute prediction tasks and prepare resources in advance. Valid values: 0 to 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'InitialMaxSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of ECS instances that can be contained in the scaling group. If you specify **InitialMaxSize**, you must specify **PredictiveValueBehavior**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'StepAdjustment', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the step adjustments.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricIntervalUpperBound' => [ + 'description' => 'The upper limit of a step adjustment. This parameter takes effect only if you set **ScalingRuleType** to **StepScalingRule**. Valid values: -9.999999E18 to 9.999999E18.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '5.0', + ], + 'ScalingAdjustment' => [ + 'description' => 'The number of ECS instances that you want to scale in each step adjustment. This parameter is available only if you set **ScalingRuleType** to **StepScalingRule**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'MetricIntervalLowerBound' => [ + 'description' => 'The lower limit in a step adjustment. This parameter is available only if you set **ScalingRuleType** to **StepScalingRule**. Valid values: -9.999999E18 to 9.999999E18.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AlarmDimension', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The dimension key of the metric.'."\n", + 'example' => 'rulePool', + ], + 'DimensionValue' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The dimension value of the metric.'."\n", + 'example' => 'sgp-j4zhc14afvtg9khq8o', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + 'description' => 'The dimension information associated with the item is applicable to the target tracking rule and is set when the item requires additional dimension information, for example, the `LoadBalancerRealServerAverageQps` item needs to specify the `rulePool` dimension information.', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HybridMonitorNamespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'HybridMetrics', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'Statistic' => [ + 'type' => 'string', + ], + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + ], + 'DimensionValue' => [ + 'type' => 'string', + ], + ], + ], + 'maxItems' => 10, + ], + ], + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AlarmOptions', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Period' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyScalingRuleResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyScalingRuleResponse>","errorExample":""}]', + 'title' => 'ModifyScalingRule', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=ModifyScalingRule\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeScalingRules' => [ + 'summary' => '查询伸缩规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92685', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '50', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group whose scaling rules you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp1ffogfdauy0jw0****', + ], + ], + [ + 'name' => 'ScalingRuleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the scaling rule. Valid values:'."\n" + ."\n" + .'* SimpleScalingRule: scales the number of Elastic Compute Service (ECS) instances based on the values of **AdjustmentType** and **AdjustmentValue**.'."\n" + .'* TargetTrackingScalingRule: calculates the number of ECS instances that must be scaled and maintains the value of a predefined metric close to the value of **TargetValue**.'."\n" + .'* StepScalingRule: scales ECS instances in steps based on the specified thresholds and metric values.'."\n" + .'* PredictiveScalingRule: uses machine learning to analyze historical monitoring data of the scaling group and predicts the future values of metrics. In addition, Auto Scaling creates scheduled tasks to adjust the minimum and maximum numbers of instances for the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SimpleScalingRule', + ], + ], + [ + 'name' => 'ShowAlarmRules', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the event-triggered tasks that are associated with the scaling rules. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ScalingRuleId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the scaling rules that you want to query.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of scaling rule *N* that you want to query. Valid values of *N*: 1 to 10.'."\n", + 'example' => 'asr-bp1dvirgwkoowxk7****', + ], + 'required' => false, + 'example' => 'asr-bp1dvirgwkoowxk7****', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ScalingRuleName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The names of the scaling rules that you want to query.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The name of scaling rule* N* that you want to query. Valid values of *N*: 1 to 10.'."\n", + 'example' => 'scalingrule****', + ], + 'required' => false, + 'example' => 'scalingrule****', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ScalingRuleAri', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The unique identifier of scaling rule *N* that you want to query. Valid values of *N*: 1 to 10.'."\n", + 'example' => 'ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****', + ], + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****', + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of scaling rules.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingRules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScalingRule' => [ + 'description' => 'The information about the scaling rules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The predefined metric of the scaling rule. If you set **ScalingRuleType** to **TargetTrackingScalingRule** or **PredictiveScalingRule**, you must specify this parameter.'."\n" + ."\n" + .'Valid values if **ScalingRuleType** is set to **TargetTrackingScalingRule**:'."\n" + ."\n" + .'* CpuUtilization: the average CPU utilization'."\n" + ."\n" + .'* ClassicInternetRx: the average inbound Internet traffic over the classic network'."\n" + ."\n" + .'* ClassicInternetTx: the average outbound Internet traffic over the classic network'."\n" + ."\n" + .'* VpcInternetRx: the average inbound Internet traffic over a virtual private cloud (VPC)'."\n" + ."\n" + .'* VpcInternetTx: the average outbound Internet traffic over a VPC'."\n" + ."\n" + .'* IntranetRx: the average inbound traffic over the internal network'."\n" + ."\n" + .'* IntranetTx: the average outbound traffic over the internal network'."\n" + ."\n" + .' Valid values if **ScalingRuleType** is set to **PredictiveScalingRule**:'."\n" + ."\n" + .'* CpuUtilization: the average CPU utilization'."\n" + ."\n" + .'* IntranetRx: the average inbound traffic over the internal network'."\n" + ."\n" + .'* IntranetTx: the average outbound traffic over the internal network'."\n", + 'type' => 'string', + 'example' => 'CpuUtilization', + ], + 'AdjustmentType' => [ + 'description' => 'The adjustment method of the scaling rule. Valid values:'."\n" + ."\n" + .'* QuantityChangeInCapacity: adds the specified number of ECS instances to or removes the specified number of ECS instances from the scaling group.'."\n" + .'* PercentChangeInCapacity: adds the specified percentage of ECS instances to or removes the specified percentage of ECS instances from the scaling group.'."\n" + .'* TotalCapacity: adjusts the number of ECS instances in the scaling group to a specified number.'."\n", + 'type' => 'string', + 'example' => 'QuantityChangeInCapacity', + ], + 'InitialMaxSize' => [ + 'description' => 'The maximum number of ECS instances that can be added to the scaling group. If you specify **InitialMaxSize**, you must also specify **PredictiveValueBehavior**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'EstimatedInstanceWarmup' => [ + 'description' => 'The warmup period of an ECS instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'ScaleOutEvaluationCount' => [ + 'description' => 'The number of consecutive times that the event-triggered task created for scale-outs must meet the threshold conditions before an alert is triggered. After a target tracking scaling rule is created, an event-triggered task is automatically created and associated with the target tracking scaling rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PredictiveScalingMode' => [ + 'description' => 'The mode of the predictive scaling rule. Valid values:'."\n" + ."\n" + .'* PredictAndScale: provides predictions and creates prediction tasks.'."\n" + .'* PredictOnly: provides predictions but does not create prediction tasks.'."\n", + 'type' => 'string', + 'example' => 'PredictAndScale', + ], + 'MinAdjustmentMagnitude' => [ + 'description' => 'The minimum number of instances that must be scaled. This parameter takes effect only if you set `ScalingRuleType` to `SimpleScalingRule` or `StepScalingRule`, and `AdjustmentType` to **PercentChangeInCapacity**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingRuleAri' => [ + 'description' => 'The unique identifier of the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****', + ], + 'PredictiveTaskBufferTime' => [ + 'description' => 'The amount of buffer time before the prediction task runs. By default, all prediction tasks that are automatically created by a predictive scaling rule run on the hour. You can specify a buffer time to run prediction tasks and prepare resources in advance. Valid values: 0 to 60. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'MinSize' => [ + 'description' => 'The minimum number of ECS instances that the scaling group must contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group whose scaling rules are queried.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1ffogfdauy0jw0****', + ], + 'PredictiveValueBehavior' => [ + 'description' => 'The action on the predicted maximum value. Valid values:'."\n" + ."\n" + .'* MaxOverridePredictiveValue: uses the initial maximum capacity as the maximum value for prediction tasks if the predicted value is greater than the initial maximum capacity.'."\n" + .'* PredictiveValueOverrideMax: uses the predicted value as the maximum value for prediction tasks if the predicted value is greater than the initial maximum capacity.'."\n" + .'* PredictiveValueOverrideMaxWithBuffer: increases the predicted value by a ratio that is specified by **PredictiveValueBuffer**, and uses the increased value as the maximum value for prediction tasks if the predicted value increased by the ratio is greater than the initial maximum capacity.'."\n", + 'type' => 'string', + 'example' => 'MaxOverridePredictiveValue', + ], + 'TargetValue' => [ + 'description' => 'The target value.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.125', + ], + 'Cooldown' => [ + 'description' => 'The cooldown period of the scaling rule. This parameter is available only if you set **ScalingRuleType** to **SimpleScalingRule**. Valid values: 0 to 86400. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'MaxSize' => [ + 'description' => 'The maximum number of ECS instances that the scaling group can contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PredictiveValueBuffer' => [ + 'description' => 'The ratio based on which the predicted value is increased if you set **PredictiveValueBehavior** to **PredictiveValueOverrideMaxWithBuffer**. If the predicted value that is increased by this ratio is greater than the initial maximum capacity, the increased value is used as the maximum value for prediction tasks. Valid values: 0 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'ScalingRuleType' => [ + 'description' => 'The type of the scaling rule. Valid values:'."\n" + ."\n" + .'* SimpleScalingRule: adjusts the number of ECS instances based on the values of **AdjustmentTyp****e** and **AdjustmentValue**.'."\n" + .'* TargetTrackingScalingRule: calculates the number of ECS instances that must be scaled and maintains the value of a predefined metric close to the value of **TargetValue**.'."\n" + .'* StepScalingRule: scales ECS instances in steps based on the specified thresholds and metric values.'."\n" + .'* PredictiveScalingRule: uses machine learning to analyze historical monitoring data of the scaling group and predicts the future values of metrics. In addition, Auto Scaling creates scheduled tasks to adjust the minimum and maximum numbers of instances for the scaling group.'."\n", + 'type' => 'string', + 'example' => 'SimpleScalingRule', + ], + 'AdjustmentValue' => [ + 'description' => 'The number of instances that need to be scaled based on the scaling rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScaleInEvaluationCount' => [ + 'description' => 'The number of consecutive times that the event-triggered task created for scale-ins must meet the threshold conditions before an alert is triggered. After a target tracking scaling rule is created, an event-triggered task is automatically created and associated with the target tracking scaling rule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'DisableScaleIn' => [ + 'description' => 'Indicates whether to disable scale-in. This parameter takes effect only if you set **ScalingRuleType** to **TargetTrackingScalingRule**. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ScalingRuleName' => [ + 'description' => 'The name of the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'scalingrule****', + ], + 'ScalingRuleId' => [ + 'description' => 'The ID of the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'asr-bp1dvirgwkoowxk7****', + ], + 'Alarms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => 'The event-triggered tasks that are associated with the scaling rule. This parameter is returned only if you set **ShowAlarmRules** to **true**. Otherwise, an empty list is returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlarmTaskId' => [ + 'description' => 'The ID of the event-triggered task that is associated with the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****', + ], + 'ComparisonOperator' => [ + 'description' => 'The comparison operator between the statistical value and the threshold of the metric in the event-triggered task that is associated with the scaling rule. The comparison operator indicates the relationship in which the metric value and the metric threshold can meet the alert condition.'."\n" + ."\n" + .'* Valid value if the metric value is greater than or equal to the metric threshold: >='."\n" + .'* Valid value if the metric value is less than or equal to the metric threshold: <='."\n" + .'* Valid value if the metric value is greater than the metric threshold: >'."\n" + .'* Valid value if the metric value is less than the metric threshold: <'."\n", + 'type' => 'string', + 'example' => '>=', + ], + 'MetricName' => [ + 'description' => 'The name of the metric in the event-triggered task that is associated with the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'CpuUtilization', + ], + 'EvaluationCount' => [ + 'description' => 'The number of consecutive times that the event-triggered task that is associated with the scaling rule must meet the alert condition before an alert is triggered.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AlarmTaskName' => [ + 'description' => 'The name of the event-triggered task that is associated with the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'alarmtask****', + ], + 'MetricType' => [ + 'description' => 'The type of the metric in the event-triggered task that is associated with the scaling rule. Valid values:'."\n" + ."\n" + .'* system: system metric'."\n" + .'* custom: custom metric'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'Threshold' => [ + 'description' => 'The threshold of the metric in the event-triggered task that is associated with the scaling rule.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '50', + ], + 'Statistics' => [ + 'description' => 'The statistical method of the event-triggered task that is associated with the scaling rule. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Maximum'."\n" + .'* Minimum'."\n", + 'type' => 'string', + 'example' => 'Average', + ], + 'Dimensions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Dimension' => [ + 'description' => 'The dimensions of the event-triggered task that is associated with the scaling rule.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'description' => 'The dimension key of the event-triggered task that is associated with the scaling rule. Valid values:'."\n" + ."\n" + .'* scaling_group: the ID of the scaling group'."\n" + .'* userId: the ID of the Alibaba Cloud account'."\n", + 'type' => 'string', + 'example' => 'scaling_group', + ], + 'DimensionValue' => [ + 'description' => 'The dimension value of the event-triggered task that is associated with the scaling rule.'."\n", + 'type' => 'string', + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + ], + ], + ], + ], + 'Period' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + 'StepAdjustments' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StepAdjustment' => [ + 'description' => 'The step adjustments of the step scaling rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricIntervalUpperBound' => [ + 'description' => 'The number of ECS instances that are scaled in a step adjustment.', + 'type' => 'number', + 'format' => 'float', + 'example' => '5.0', + ], + 'ScalingAdjustment' => [ + 'description' => 'The lower limit that is specified in a step adjustment. Valid values: -9.999999E18 to 9.999999E18.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MetricIntervalLowerBound' => [ + 'description' => 'auditing', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + ], + 'description' => 'The upper limit that is specified in a step adjustment. Valid values: -9.999999E18 to 9.999999E18.', + ], + ], + ], + ], + 'AlarmDimensions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmDimension' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + ], + 'DimensionValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'MetricType' => [ + 'type' => 'string', + ], + 'HybridMonitorNamespace' => [ + 'type' => 'string', + ], + 'HybridMetrics' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HybridMetric' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'Statistic' => [ + 'type' => 'string', + ], + 'Dimensions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Dimension' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + ], + 'DimensionValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 1,\\n \\"ScalingRules\\": {\\n \\"ScalingRule\\": [\\n {\\n \\"MetricName\\": \\"CpuUtilization\\",\\n \\"AdjustmentType\\": \\"QuantityChangeInCapacity\\",\\n \\"InitialMaxSize\\": 100,\\n \\"EstimatedInstanceWarmup\\": 300,\\n \\"ScaleOutEvaluationCount\\": 3,\\n \\"PredictiveScalingMode\\": \\"PredictAndScale\\",\\n \\"MinAdjustmentMagnitude\\": 1,\\n \\"ScalingRuleAri\\": \\"ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****\\",\\n \\"PredictiveTaskBufferTime\\": 30,\\n \\"MinSize\\": 1,\\n \\"ScalingGroupId\\": \\"asg-bp1ffogfdauy0jw0****\\",\\n \\"PredictiveValueBehavior\\": \\"MaxOverridePredictiveValue\\",\\n \\"TargetValue\\": 0.125,\\n \\"Cooldown\\": 20,\\n \\"MaxSize\\": 2,\\n \\"PredictiveValueBuffer\\": 50,\\n \\"ScalingRuleType\\": \\"SimpleScalingRule\\",\\n \\"AdjustmentValue\\": 1,\\n \\"ScaleInEvaluationCount\\": 15,\\n \\"DisableScaleIn\\": true,\\n \\"ScalingRuleName\\": \\"scalingrule****\\",\\n \\"ScalingRuleId\\": \\"asr-bp1dvirgwkoowxk7****\\",\\n \\"Alarms\\": {\\n \\"Alarm\\": [\\n {\\n \\"AlarmTaskId\\": \\"asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****\\",\\n \\"ComparisonOperator\\": \\">=\\",\\n \\"MetricName\\": \\"CpuUtilization\\",\\n \\"EvaluationCount\\": 3,\\n \\"AlarmTaskName\\": \\"alarmtask****\\",\\n \\"MetricType\\": \\"system\\",\\n \\"Threshold\\": 50,\\n \\"Statistics\\": \\"Average\\",\\n \\"Dimensions\\": {\\n \\"Dimension\\": [\\n {\\n \\"DimensionKey\\": \\"scaling_group\\",\\n \\"DimensionValue\\": \\"asg-bp18p2yfxow2dloq****\\"\\n }\\n ]\\n },\\n \\"Period\\": 60\\n }\\n ]\\n },\\n \\"StepAdjustments\\": {\\n \\"StepAdjustment\\": [\\n {\\n \\"MetricIntervalUpperBound\\": 5,\\n \\"ScalingAdjustment\\": 1,\\n \\"MetricIntervalLowerBound\\": 1\\n }\\n ]\\n },\\n \\"AlarmDimensions\\": {\\n \\"AlarmDimension\\": [\\n {\\n \\"DimensionKey\\": \\"rulePool\\",\\n \\"DimensionValue\\": \\"sgp-l1cbirz451yxu2****\\"\\n }\\n ]\\n },\\n \\"MetricType\\": \\"system\\",\\n \\"HybridMonitorNamespace\\": \\"aliyun-test\\",\\n \\"HybridMetrics\\": {\\n \\"HybridMetric\\": [\\n {\\n \\"Id\\": \\"a\\",\\n \\"Expression\\": \\"(a+b)/2\\",\\n \\"MetricName\\": \\"AliyunSmq_NumberOfMessagesVisible\\",\\n \\"Statistic\\": \\"Average\\",\\n \\"Dimensions\\": {\\n \\"Dimension\\": [\\n {\\n \\"DimensionKey\\": \\"queue\\",\\n \\"DimensionValue\\": \\"testQueue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeScalingRulesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>50</PageSize>\\n <TotalCount>1</TotalCount>\\n <ScalingRules>\\n <MetricName>CpuUtilization</MetricName>\\n <AdjustmentType>QuantityChangeInCapacity</AdjustmentType>\\n <InitialMaxSize>100</InitialMaxSize>\\n <EstimatedInstanceWarmup>300</EstimatedInstanceWarmup>\\n <ScaleOutEvaluationCount>3</ScaleOutEvaluationCount>\\n <PredictiveScalingMode>PredictAndScale</PredictiveScalingMode>\\n <MinAdjustmentMagnitude>1</MinAdjustmentMagnitude>\\n <ScalingRuleAri>ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****</ScalingRuleAri>\\n <PredictiveTaskBufferTime>30</PredictiveTaskBufferTime>\\n <MinSize>1</MinSize>\\n <ScalingGroupId>asg-bp1ffogfdauy0jw0****</ScalingGroupId>\\n <PredictiveValueBehavior>MaxOverridePredictiveValue</PredictiveValueBehavior>\\n <TargetValue>0.125</TargetValue>\\n <Cooldown>20</Cooldown>\\n <MaxSize>2</MaxSize>\\n <PredictiveValueBuffer>50</PredictiveValueBuffer>\\n <ScalingRuleType>SimpleScalingRule</ScalingRuleType>\\n <AdjustmentValue>1</AdjustmentValue>\\n <ScaleInEvaluationCount>15</ScaleInEvaluationCount>\\n <DisableScaleIn>true</DisableScaleIn>\\n <ScalingRuleName>scalingrule****</ScalingRuleName>\\n <ScalingRuleId>asr-bp1dvirgwkoowxk7****</ScalingRuleId>\\n <Alarms>\\n <AlarmTaskId>asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****</AlarmTaskId>\\n <ComparisonOperator>>=</ComparisonOperator>\\n <MetricName>CpuUtilization</MetricName>\\n <EvaluationCount>3</EvaluationCount>\\n <AlarmTaskName>alarmtask****</AlarmTaskName>\\n <MetricType>system</MetricType>\\n <Threshold>50</Threshold>\\n <Statistics>Average</Statistics>\\n <Dimensions>\\n <DimensionKey>scaling_group</DimensionKey>\\n <DimensionValue>asg-bp18p2yfxow2dloq****</DimensionValue>\\n </Dimensions>\\n </Alarms>\\n <StepAdjustments>\\n <MetricIntervalUpperBound>5</MetricIntervalUpperBound>\\n <ScalingAdjustment>1</ScalingAdjustment>\\n <MetricIntervalLowerBound>1</MetricIntervalLowerBound>\\n </StepAdjustments>\\n <AlarmDimensions>\\n <DimensionKey>rulePool</DimensionKey>\\n <DimensionValue>sgp-l1cbirz451yxu2****</DimensionValue>\\n </AlarmDimensions>\\n </ScalingRules>\\n</DescribeScalingRulesResponse>","errorExample":""}]', + 'title' => 'DescribeScalingRules', + 'description' => '## Usage notes'."\n" + ."\n" + .'You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachInstances' => [ + 'summary' => '为伸缩组手动添加实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92649', + 'abilityTreeNodes' => [ + 'FEATUREessBFHJ1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'Entrusted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the scaling group manages the lifecycle of instances that are manually added to the scaling group. Valid values:'."\n" + ."\n" + .'* true: The scaling group manages the lifecycle of instances that are manually added in a similar manner in which the scaling group manages the lifecycle of automatically created instances. When the instances are removed from the scaling group, the instances are automatically released. However, if you call the DetachInstances operation to remove the instances from the scaling group, the instances are not released.'."\n" + .'* false: The scaling group does not manage the lifecycle of instances that are manually added. After the instances are removed from the scaling group, the instances are not released.'."\n" + ."\n" + .'> This parameter is unavailable for subscription instances.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of instance N that you want to add. Valid values of N: 1 to 20.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* The ID of the ECS instance that you want to add is `i-28wt4****`.'."\n" + .'* The ID of the elastic container instance that you want to add is `eci-bp17gw49eu09yiwm****`.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of instance N that you want to add. Valid values of N: 1 to 20.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* The ID of the ECS instance that you want to add is `i-28wt4****`.'."\n" + .'* The ID of the elastic container instance that you want to add is `eci-bp17gw49eu09yiwm****`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-28wt4****', + ], + 'required' => false, + 'example' => 'i-28wt4****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LoadBalancerWeight', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The weight of instance N as a backend server of the Server Load Balancer (SLB) instance that is associated with the scaling group to which you want to add instance N. Valid values of N: 1 to 20. Valid values of this parameter: 1 to 100.'."\n" + ."\n" + .'Default value: 50.', + 'type' => 'array', + 'items' => [ + 'description' => 'The weight of instance N as a backend server of the Server Load Balancer (SLB) instance that is associated with the scaling group to which you want to add instance N. Valid values of N: 1 to 20. Valid values of this parameter: 1 to 100.'."\n" + ."\n" + .'Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'required' => false, + 'example' => '50', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LifecycleHook', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to trigger a lifecycle hook for the scaling group to which instances are being added. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'IgnoreInvalidInstance', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp1crxor24s28xf1****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp1crxor24s28xf1****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachInstancesResponse>\\n <ScalingActivityId>asa-bp1crxor24s28xf1****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</AttachInstancesResponse>","errorExample":""}]', + 'title' => 'AttachInstances', + 'description' => '## Description'."\n" + ."\n" + .'Before you call this operation, make sure that the following conditions are met:'."\n" + ."\n" + .'* The scaling group is in the Active state.'."\n" + .'* No scaling activities in the scaling group are in progress.'."\n" + ."\n" + .'The ECS instances and the elastic container instances that you want to add to a scaling group must meet the following requirements:'."\n" + ."\n" + .'* The instances reside in the same region as the scaling group.'."\n" + .'* The instances are in the Running state.'."\n" + .'* The instances are not added to other scaling groups.'."\n" + .'* The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.'."\n" + .'* If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.'."\n" + .'* If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.'."\n" + ."\n" + .'If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.'."\n" + ."\n" + .'A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.'."\n" + ."\n" + .'If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the MaxSize value, the call fails.'."\n" + ."\n" + .'Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DetachInstances' => [ + 'summary' => '从一个伸缩组移出一台或多台实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92690', + 'abilityTreeNodes' => [ + 'FEATUREessDFX5TO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'DecreaseDesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to adjust the expected number of instances in the scaling group. Valid values:'."\n" + ."\n" + .'* true: After a specific number of instances are removed from the scaling group, the expected number of instances in the scaling group decreases.'."\n" + .'* false: After a specific number of instances are removed from the scaling group, the expected number of instances in the scaling group remains unchanged.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IgnoreInvalidInstance', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'DetachOption', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove the instances from the default server groups and vServer groups of the Server Load Balancer (SLB) instance that is associated with the scaling group, and whether to remove the IP addresses of the instances from the whitelist that manages access to the ApsaraDB RDS instance that is associated with the scaling group.'."\n" + ."\n" + .'If you set this parameter to both, the instances are removed from the default sever groups and vServer groups of the associated SLB instance, and the IP addresses of the instances are removed from the whitelist that manages access to the associated ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'both', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of ECS instance N or elastic container instance N that you want to remove from the scaling group. Valid values of N: 1 to 20.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* The ID of the ECS instance that you want to remove is `i-bp109k5j3dum1ce6****`.'."\n" + .'* The ID of the elastic container instance that you want to remove is `eci-bp17gw49eu09yiwm****`.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of ECS instance N or elastic container instance N that you want to remove from the scaling group. Valid values of N: 1 to 20.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* The ID of the ECS instance that you want to remove is `i-bp109k5j3dum1ce6****`.'."\n" + .'* The ID of the elastic container instance that you want to remove is `eci-bp17gw49eu09yiwm****`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp109k5j3dum1ce6****', + ], + 'required' => true, + 'example' => 'i-bp109k5j3dum1ce6****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LifecycleHook', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to trigger the lifecycle hook for the scaling group when you remove instances from the scaling group. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp1gbswjhjrw8tko****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp1gbswjhjrw8tko****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachInstancesResponse>\\n <ScalingActivityId>asa-bp1gbswjhjrw8tko****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DetachInstancesResponse>","errorExample":""}]', + 'title' => 'DetachInstances', + 'description' => '## Description'."\n" + ."\n" + .'After ECS instances or elastic container instances are removed from a scaling group, you can call the [AttachInstances](~~25954~~) operation to add the ECS instances or elastic container instances that are removed from the scaling group to other scaling groups.'."\n" + ."\n" + .'After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.'."\n" + ."\n" + .'Before you call this operation, make sure that the following conditions are met:'."\n" + ."\n" + .'* The specified scaling group is enabled.'."\n" + .'* No scaling activities in the specified scaling group are in progress.'."\n" + ."\n" + .'If no scaling activities in the specified scaling group are in progress, the operation can immediately trigger scaling activities without the need to wait for the cooldown time to expire.'."\n" + ."\n" + .'A successful call indicates only that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity based on the return value of the ScalingActivityId parameter.'."\n" + ."\n" + .'The number of ECS instances or elastic container instances in a scaling group after you remove a specific number of instances from the scaling group must be equal to or greater than the value of the MinSize parameter. Otherwise, an error is reported when you call the DetachInstances operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ExecuteScalingRule' => [ + 'summary' => '执行一条伸缩规则', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92698', + 'abilityTreeNodes' => [ + 'FEATUREessKCZYL8', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingRuleAri', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the scaling rule.'."\n" + ."\n" + .'> You can call the ExecuteScalingRule operation to execute only simple scaling rules and step scaling rules. To execute a step scaling rule, you must specify both BreachThreshold and MetricValue.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'BreachThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The threshold specified when the step scaling rule is executed. Valid values: -9.999999E18~9.999999E18.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'MetricValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metric value specified when the step scaling rule is executed. Valid values: -9.999999E18~9.999999E18.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp13o672yeautiil****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp13o672yeautiil****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ExecuteScalingRuleResponse>\\n <ScalingActivityId>asa-bp13o672yeautiil****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ExecuteScalingRuleResponse>","errorExample":""}]', + 'title' => 'ExecuteScalingRule', + 'description' => '## Description'."\n" + ."\n" + .'Before you call this operation, make sure that the following conditions are met:'."\n" + ."\n" + .'* The scaling group is in the Active state.'."\n" + .'* The scaling group does not have scaling activities in progress.'."\n" + ."\n" + .'If no scaling activity is being executed in the scaling group, this operation can trigger scaling activities immediately without waiting for the cooldown time to expire.'."\n" + ."\n" + .'If the call is successful, Auto Scaling has accepted the request. However, this does not mean that the scaling activity will succeed. You can determine the status of a scaling activity based on the return value of the ScalingActivityId parameter.'."\n" + ."\n" + .'If the number of ECS instances to be added will leave the number of instances in the scaling group greater than MaxSize, Auto Scaling adds the proper number of ECS instances to maintain the number of ECS instances in the scaling group equal to the MaxSize value.'."\n" + ."\n" + .'If the number of ECS instances to be removed will leave the number of instances in the scaling group less than MinSize, Auto Scaling removes the proper number of ECS instances to maintain the number of ECS instances in the scaling group equal to the MinSize value.'."\n" + ."\n" + .'A limited number of ECS instances can be adjusted at a time. For more information, see the description about the AdjustmentValue parameter in [CreateScalingRule](~~25948~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'RemoveInstances' => [ + 'summary' => '从一个伸缩组删除一台或多台实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '92714', + 'abilityTreeNodes' => [ + 'FEATUREessDFX5TO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'RemovePolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that is performed when ECS instances are removed. Valid values:'."\n" + ."\n" + .'* recycle: The ECS instances enter the economical mode.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** This setting takes effect only if you set ScalingPolicy to recycle.'."\n" + ."\n" + .'* release: The ECS instances are released.'."\n" + ."\n" + .'The ScalingPolicy parameter that you specify when you call the CreateScalingGroup operation specifies the reclaim mode of the scaling group. The RemovePolicy parameter that you specify when you call the RemoveInstances operation specifies the action to be performed on ECS instances when the ECS instances are removed. Examples:'."\n" + ."\n" + .'* If you set ScalingPolicy and RemovePolicy to recycle, the ECS instances enter the economical mode when they are removed.'."\n" + .'* If you set ScalingPolicy to recycle and RemovePolicy to release, the ECS instances are released when they are removed.'."\n" + .'* If you set ScalingPolicy to release and RemovePolicy to recycle, the ECS instances are released when they are removed.'."\n" + .'* If you set ScalingPolicy and RemovePolicy to release, the ECS instances are released when they are removed.'."\n" + ."\n" + .'Default value: release.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'release', + ], + ], + [ + 'name' => 'DecreaseDesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to adjust the expected number of ECS instances in the scaling group. Valid values:'."\n" + ."\n" + .'* true: After ECS instances are removed from a scaling group, the expected number of ECS instances in the scaling group decreases.'."\n" + .'* false: After ECS instances are removed from a scaling group, the expected number of ECS instances in the scaling group remains unchanged.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IgnoreInvalidInstance', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of ECS instance N that you want to remove. Valid values of N: 1 to 20.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of ECS instance N that you want to remove. Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-28wt4****', + ], + 'required' => true, + 'example' => 'i-28wt4****', + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'StopInstanceTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'LifecycleHookContext', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DisableLifecycleHook' => [ + 'type' => 'boolean', + ], + 'IgnoredLifecycleHookIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'LifecycleHookResult' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp175o6f6ego3r2j****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'IgnoredInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IgnoredInstance' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp175o6f6ego3r2j****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"IgnoredInstances\\": {\\n \\"IgnoredInstance\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RemoveInstancesResponse>\\n <ScalingActivityId>asa-bp175o6f6ego3r2j****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</RemoveInstancesResponse>","errorExample":""}]', + 'title' => 'RemoveInstances', + 'description' => '## Description'."\n" + ."\n" + .'* Before you call this operation, make sure that the following requirements are met:'."\n" + ."\n" + .' * The scaling group is in the Active state.'."\n" + .' * No scaling activity is in progress within the scaling group.'."\n" + ."\n" + .'If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.'."\n" + ."\n" + .'* If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance enters the economical mode or is released when the instance is removed from the scaling group.'."\n" + .'* If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released when the instance is removed from the scaling group.'."\n" + .'* If the difference between the number of existing ECS instances specified by TotalCapacity and the number of ECS instances that you specified to remove is less than the value of MinSize, the call fails.'."\n" + ."\n" + .'A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CreateScheduledTask' => [ + 'summary' => '创建一个定时任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92660', + 'abilityTreeNodes' => [ + 'FEATUREess30IPAO', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scheduled task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'ScheduledTaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scheduled task. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit. The name of the scheduled task must be unique in the region and within the Alibaba Cloud account.'."\n" + ."\n" + .'By default, the value of the `ScheduledTaskId` parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scheduled****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the scheduled task. The description must be 2 to 200 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test scheduled task.', + ], + ], + [ + 'name' => 'ScheduledAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scaling rule that you want to execute when the scheduled task is triggered. Specify the unique identifier of the scaling rule. If you specify the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.'."\n" + ."\n" + .'> You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp12tcnol686y1ik****', + ], + ], + [ + 'name' => 'RecurrenceEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the scheduled task. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format.'."\n" + ."\n" + .'The time must be in UTC. You cannot enter a point in time that is later than 365 days from the point in time at which the scheduled task is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-08-17T16:55Z', + ], + ], + [ + 'name' => 'LaunchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a point in time that is later than 90 days from the point in time at which the scheduled task is created.'."\n" + ."\n" + .'* If you specify the `RecurrenceType` parameter, the scheduled task is repeatedly executed at the point in time that is specified by the LaunchTime parameter.'."\n" + .'* If you do not specify the `RecurrenceType` parameter, the task is executed only once at the point in time that is specified by the LaunchTime parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-08-17T16:52Z', + 'docRequired' => true, + ], + ], + [ + 'name' => 'RecurrenceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which the scheduled task is repeatedly executed. Valid values:'."\n" + ."\n" + .'* Daily: The scheduled task is executed once every specified number of days.'."\n" + .'* Weekly: The scheduled task is executed on each specified day of a week.'."\n" + .'* Monthly: The scheduled task is executed on each specified day of a month.'."\n" + .'* Cron: The scheduled task is executed based on the specified cron expression.'."\n" + ."\n" + .'You must specify the `RecurrenceType` and `RecurrenceValue` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Daily', + ], + ], + [ + 'name' => 'RecurrenceValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of recurrences of the scheduled task.'."\n" + ."\n" + .'* If you set the `RecurrenceType` parameter to `Daily`, you can specify only one value. Valid values: 1 to 31.'."\n" + .'* If you set the `RecurrenceType` parameter to `Weekly`, you can specify multiple values. Separate the values with commas (,). The values that correspond to Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0, 1, 2, 3, 4, 5, and 6.'."\n" + .'* If you set the `RecurrenceType` parameter to `Monthly`, you can specify two values in the `A-B` format. Valid values of A and B: 1 to 31. B must be greater than or equal to A.'."\n" + .'* If you set the `RecurrenceType` parameter to `Cron`, you can specify a cron expression. A cron expression is written in UTC time and consists of the following fields: minute, hour, day, month, and week. The expression can contain the letters L and W and the following wildcard characters: commas (,), question marks (?), hyphens (-), asterisks (\\*), number signs (#), and forward slashes (/).'."\n" + ."\n" + .'You must specify the `RecurrenceType` and `RecurrenceValue` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the scheduled task.'."\n" + ."\n" + .'* true: enables the scheduled task.'."\n" + .'* false: disables the scheduled task.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LaunchExpirationTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The period of time during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600.'."\n" + ."\n" + .'Default value: 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '86400', + 'minimum' => '0', + 'example' => '600', + 'default' => '600', + ], + ], + [ + 'name' => 'MinValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expected number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.'."\n" + ."\n" + .'> You must specify the `DesiredCapacity` parameter when you create a scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group whose number of instances is changed when the scheduled task is triggered. If you specify the `ScalingGroupId` parameter for a scheduled task, the scaling method of the scheduled task is to specify the number of instances in the scaling group. In this case, you must specify at least one of the `MinValue`, `MaxValue`, and `DesiredCapacity` parameters.'."\n" + ."\n" + .'> You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScheduledTaskId' => [ + 'description' => 'The globally unique ID of the scheduled task. The globally unique ID is generated by the system.'."\n", + 'type' => 'string', + 'example' => 'edRtShc57WGXdt8TlPbr****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScheduledTaskId\\": \\"edRtShc57WGXdt8TlPbr****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateScheduledTaskResponse>\\n <ScheduledTaskId>edRtShc57WGXdt8TlPbr****</ScheduledTaskId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</CreateScheduledTaskResponse>","errorExample":""}]', + 'title' => 'CreateScheduledTask', + 'description' => '## Description'."\n" + ."\n" + .'* If a scheduled task fails to execute a scaling rule due to an ongoing scaling activity in a scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the period that is specified by the `LaunchExpirationTime` parameter. If the scheduled task still fails after the specified period ends, the task is automatically skipped.'."\n" + ."\n" + .'* If multiple tasks are scheduled at similar points in time to execute scaling rules in the same scaling group, the earliest task triggers the first scaling activity. Other tasks execute scaling rules within their launch expiration time. Only one scaling activity can be triggered in a scaling group at a time. If the previous scaling activity is complete and another scheduled task attempts to trigger a scaling activity, Auto Scaling executes the scaling rule that is specified in the scheduled task and then triggers a scaling activity.'."\n" + ."\n" + .'* A scheduled task supports the following scaling methods:'."\n" + ."\n" + .' * If you specify the `ScheduledAction` parameter, the scaling method of the scheduled task is to specify an existing scaling rule that you want to execute when the scheduled task is triggered.'."\n" + ."\n" + .' * If you specify the `ScalingGroupId` parameter, the scaling method of the scheduled task is to specify the minimum number, maximum number, or expected number of instances in the scaling group for which you create the scheduled task.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteScheduledTask' => [ + 'summary' => '删除一个定时任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92669', + 'abilityTreeNodes' => [ + 'FEATUREess30IPAO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScheduledTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scheduled task. An ID is a globally unique identifier (GUID) that is generated by the system for a scheduled task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'edRtShc57WGXdt8TlPbr****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scheduled task is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScheduledTaskResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DeleteScheduledTaskResponse>","errorExample":""}]', + 'title' => 'DeleteScheduledTask', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DeleteScheduledTask\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyScheduledTask' => [ + 'summary' => '修改一个定时任务的信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92711', + 'abilityTreeNodes' => [ + 'FEATUREessAWW1X1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScheduledTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scheduled task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'edRtShc57WGXdt8TlPbr****', + ], + ], + [ + 'name' => 'ScheduledTaskName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scheduled task. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit. The name of the scheduled task must be unique in the region and within the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scheduled****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the scheduled task. The description must be 2 to 200 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test scheduled task.', + ], + ], + [ + 'name' => 'ScheduledAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scaling rule that you want to execute when the scheduled task is triggered. Specify the unique identifier of the scaling rule. If you specify the `ScheduledAction` parameter, you must select an existing scaling rule.'."\n" + ."\n" + .'> You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:14069264****:scalingrule/asr-bp12tcnol686y1ik****', + ], + ], + [ + 'name' => 'RecurrenceEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the scheduled task. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the scheduled task modification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-08-20T16:55Z', + ], + ], + [ + 'name' => 'LaunchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time at which the scheduled task was triggered. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a time point later than 90 days from the scheduled task modification.'."\n" + ."\n" + .'* If you specify the `RecurrenceType` parameter, the task is repeatedly executed at the time point that is specified by the LaunchTime parameter.'."\n" + .'* If you do not specify the `RecurrenceType` parameter, the task is executed only once at the time point that is specified by the LaunchTime parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2014-08-18T10:52Z', + ], + ], + [ + 'name' => 'RecurrenceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which the scheduled task is repeatedly executed. Valid values:'."\n" + ."\n" + .'* Daily: The scheduled task is executed once every specified number of days.'."\n" + .'* Weekly: The scheduled task is executed on each specified day of a week.'."\n" + .'* Monthly: The scheduled task is executed on each specified day of a month.'."\n" + .'* Cron: The scheduled task is executed based on the specified cron expression.'."\n" + ."\n" + .'After you modify the scheduled task, the values that you specify for the `RecurrenceType` and `RecurrenceValue` parameters must be valid at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Daily', + ], + ], + [ + 'name' => 'RecurrenceValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of recurrences of the scheduled task.'."\n" + ."\n" + .'* If you set the `RecurrenceType` parameter to `Daily`, you can specify only one value. Valid values: 1 to 31.'."\n" + .'* If you set the `RecurrenceType` parameter to `Weekly`, you can specify multiple values. Separate them with commas (,). For example, the values that correspond to Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0, 1, 2, 3, 4, 5, and 6.``'."\n" + .'* If you set the `RecurrenceType` parameter to `Monthly`, you can specify two values in the `A-B` format. Valid values of A and B: 1 to 31. B must be greater than or equal to A.'."\n" + .'* If you set `RecurrenceType` to `Cron`, you can specify a cron expression. A cron expression is written in UTC time and consists of the following fields: minute, hour, day, month, and week. The expression can contain wildcard characters, including commas (,), question marks (?), hyphens (-), asterisks (\\*), number signs (#), forward slashes (/), and the letters L and W.'."\n" + ."\n" + .'After you modify the scheduled task, the values that you specify for the `RecurrenceType` and `RecurrenceValue` parameters must be valid at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'TaskEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the scheduled task. Valid values:'."\n" + ."\n" + .'* true: enables the scheduled task.'."\n" + .'* false: disables the scheduled task.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LaunchExpirationTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time period during which the failed scheduled task can be retried. Unit: seconds. Valid values: 0 to 1800.'."\n" + ."\n" + .'Default value: 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '86400', + 'minimum' => '0', + 'example' => '600', + ], + ], + [ + 'name' => 'MinValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of instances in the scaling group if you specify the ScalingGroupId parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expected number of instances in the scaling group if you specify the ScalingGroupId parameter.'."\n" + ."\n" + .'> You must specify the `DesiredCapacity` parameter when you create the scaling group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group whose number of instances is changed when the scheduled task is triggered. If you specify the `ScalingGroupId` parameter, you must specify at least one of the `MinValue`, `MaxValue`, and `DesiredCapacity` parameters.'."\n" + ."\n" + .'> You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Throttling', + 'errorMessage' => 'Request was denied due to request throttling.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyScheduledTaskResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyScheduledTaskResponse>","errorExample":""}]', + 'title' => 'ModifyScheduledTask', + 'description' => '## Description'."\n" + ."\n" + .'You can use the following parameters to specify the scaling method of a scheduled task:'."\n" + ."\n" + .'* If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.'."\n" + .'* If you use the `ScalingGroupId` parameter, you must specify at least one of the minimum number, maximum number, and expected number of instances in the scheduled task for a scaling group.'."\n" + ."\n" + .'> You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeScheduledTasks' => [ + 'summary' => '查询定时任务的信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92686', + 'abilityTreeNodes' => [ + 'FEATUREessAWW1X1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group to which a scheduled task belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the scheduled task list to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '50', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group in which you want to execute the scheduled task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp1bo5tca4m56nap****', + ], + ], + [ + 'name' => 'ScheduledAction', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The actions that you want Auto Scaling to perform when the scheduled task is triggered.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The operation that you want to perform when scheduled task N is triggered. Valid values of N: 1 to 20.'."\n", + 'example' => 'ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****', + ], + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ScheduledTaskId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The total number of scheduled tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of scheduled task N that you want to query. Valid values of N: 1 to 20.'."\n", + 'example' => 'edRtShc57WGXdt8TlPbr****', + ], + 'required' => false, + 'example' => 'edRtShc57WGXdt8TlPbr****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ScheduledTaskName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The total number of scheduled tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The name of scheduled task N that you want to query. Valid values of N: 1 to 20.'."\n", + 'example' => 'scheduled****', + ], + 'required' => false, + 'example' => 'scheduled****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RecurrenceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RecurrenceValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'TaskEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of scheduled tasks.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScheduledTasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScheduledTask' => [ + 'description' => 'The collection of scheduled tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskEnabled' => [ + 'description' => 'Specifies whether the scheduled task is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecurrenceValue' => [ + 'description' => 'The number of recurrences of the scheduled task.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'RecurrenceType' => [ + 'description' => 'The interval at which the scheduled task recurs.'."\n", + 'type' => 'string', + 'example' => 'Daily', + ], + 'MaxValue' => [ + 'description' => 'The maximum number of instances in the scaling group when the Scaling Method parameter of the scheduled task is set to Configure Number of Instances in Scaling Group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ScheduledTaskName' => [ + 'description' => 'The name of the scheduled task.'."\n", + 'type' => 'string', + 'example' => 'scheduled****', + ], + 'RecurrenceEndTime' => [ + 'description' => 'The end time of the recurrence of the scheduled task.'."\n", + 'type' => 'string', + 'example' => '2014-08-20T16:55Z', + ], + 'DesiredCapacity' => [ + 'description' => 'The expected number of instances in the scaling group when the Scaling Method parameter of the scheduled task is set to Configure Number of Instances in Scaling Group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ScheduledTaskId' => [ + 'description' => 'The ID of the scheduled task.'."\n", + 'type' => 'string', + 'example' => 'edRtShc57WGXdt8TlPbr****', + ], + 'MinValue' => [ + 'description' => 'The minimum number of instances in the scaling group when the Scaling Method parameter of the scheduled task is set to Configure Number of Instances in Scaling Group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group in which you want to execute the scheduled task.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1bo5tca4m56nap****', + ], + 'LaunchExpirationTime' => [ + 'description' => 'The time period during which the failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'Description' => [ + 'description' => 'The description of the scheduled task.'."\n", + 'type' => 'string', + 'example' => 'Test scheduled task.', + ], + 'ScheduledAction' => [ + 'description' => 'The scaling rule that you want to use to execute the scheduled task. This parameter is returned only if a scaling rule is specified for the scheduled task.'."\n", + 'type' => 'string', + 'example' => 'ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****', + ], + 'LaunchTime' => [ + 'description' => 'The point in time at which the scheduled task is triggered.'."\n", + 'type' => 'string', + 'example' => '2014-08-18T10:52Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 1,\\n \\"ScheduledTasks\\": {\\n \\"ScheduledTask\\": [\\n {\\n \\"TaskEnabled\\": true,\\n \\"RecurrenceValue\\": \\"1\\",\\n \\"RecurrenceType\\": \\"Daily\\",\\n \\"MaxValue\\": 10,\\n \\"ScheduledTaskName\\": \\"scheduled****\\",\\n \\"RecurrenceEndTime\\": \\"2014-08-20T16:55Z\\",\\n \\"DesiredCapacity\\": 10,\\n \\"ScheduledTaskId\\": \\"edRtShc57WGXdt8TlPbr****\\",\\n \\"MinValue\\": 0,\\n \\"ScalingGroupId\\": \\"asg-bp1bo5tca4m56nap****\\",\\n \\"LaunchExpirationTime\\": 600,\\n \\"Description\\": \\"Test scheduled task.\\",\\n \\"ScheduledAction\\": \\"ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****\\",\\n \\"LaunchTime\\": \\"2014-08-18T10:52Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeScheduledTasksResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>50</PageSize>\\n <TotalCount>1</TotalCount>\\n <ScheduledTasks>\\n <TaskEnabled>true</TaskEnabled>\\n <RecurrenceValue>1</RecurrenceValue>\\n <RecurrenceType>Daily</RecurrenceType>\\n <MaxValue>10</MaxValue>\\n <ScheduledTaskName>scheduled****</ScheduledTaskName>\\n <RecurrenceEndTime>2014-08-20T16:55Z</RecurrenceEndTime>\\n <DesiredCapacity>10</DesiredCapacity>\\n <ScheduledTaskId>edRtShc57WGXdt8TlPbr****</ScheduledTaskId>\\n <MinValue>0</MinValue>\\n <ScalingGroupId>asg-bp1bo5tca4m56nap****</ScalingGroupId>\\n <LaunchExpirationTime>600</LaunchExpirationTime>\\n <Description>Test scheduled task.</Description>\\n <ScheduledAction>ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****</ScheduledAction>\\n <LaunchTime>2014-08-18T10:52Z</LaunchTime>\\n </ScheduledTasks>\\n</DescribeScheduledTasksResponse>","errorExample":""}]', + 'title' => 'DescribeScheduledTasks', + 'description' => '## Description'."\n" + ."\n" + .'You can query scheduled tasks based on scaling rule, task ID, and task name.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLifecycleHook' => [ + 'summary' => '为伸缩组创建一个生命周期挂钩', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92655', + 'abilityTreeNodes' => [ + 'FEATUREessZQ2TYX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1eyv4qn8ssgv43****', + ], + ], + [ + 'name' => 'LifecycleHookName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the lifecycle hook. Each lifecycle hook name must be unique within a scaling group. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n" + ."\n" + .'If you do not specify this parameter, the value of the LifecycleHookId parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lifecyclehook****', + ], + ], + [ + 'name' => 'LifecycleTransition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the scaling activities to which you want to apply the lifecycle hook. Valid values:'."\n" + ."\n" + .'* SCALE_OUT: scale-out activities'."\n" + .'* SCALE_IN: scale-in activities'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SCALE_OUT', + ], + ], + [ + 'name' => 'DefaultResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Auto Scaling performs after the lifecycle hook times out. Valid values:'."\n" + ."\n" + .'* CONTINUE: Auto Scaling continues to respond to a scale-in or scale-out request.'."\n" + .'* ABANDON: Auto Scaling releases ECS instances that are created during scale-out activities or removes ECS instances from the scaling group during scale-in activities.'."\n" + .'* ROLLBACK: For scale-in activities, Auto Scaling rejects the requests to release ECS instances but rolls back ECS instances. For scale-out activities, the ROLLBACK setting has the same effect as the `ABANDON` setting.'."\n" + ."\n" + .'If a scaling group has multiple lifecycle hooks in effect and you set the `DefaultResult` parameter for one of the lifecycle hooks to `ABANDON` or `ROLLBACK`, the following rule applies to scale-in activities: When the lifecycle hook whose **DefaultResult** parameter is set to **ABANDON** or **ROLLBACK** times out, other lifecycle hooks time out ahead of schedule. In other cases, Auto Scaling performs the action only after all lifecycle hooks time out. The action that Auto Scaling performs is specified by the **DefaultResult** parameter of the last lifecycle hook that times out.'."\n" + ."\n" + .'Default value: CONTINUE.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTINUE', + ], + ], + [ + 'name' => 'HeartbeatTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The period of time before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that is specified by the **DefaultResult** parameter. Valid values: 30 to 21600. Unit: seconds.'."\n" + ."\n" + .'You can call the [RecordLifecycleActionHeartbeat](~~73846~~) operation to extend the period of time before a lifecycle hook times out. You can also call the [CompleteLifecycleAction](~~73847~~) operation to end a lifecycle hook ahead of schedule.'."\n" + ."\n" + .'Default value: 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'NotificationMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fixed string that is included in a notification that Auto Scaling sends when the lifecycle hook takes effect. Auto Scaling sends the value of the NotificationMetadata parameter together with the notification. This helps you categorize your notifications. If you specify this parameter, you must also specify the `NotificationArn` parameter. The value of this parameter cannot exceed 4,096 characters in length.'."\n" + ."\n" + .'If you use the `NotificationArn` parameter to specify a public or custom OOS template, the value of the `NotificationMetadata` parameter must be a JSON string that contains the OOS template parameters.'."\n" + ."\n" + .'For example, your OOS template includes the following parameters: `{"dbInstanceId": "dds-bp17661e0135****", "modifyMode": "Append"}`, `dbInstanceId`, and `modifyMode`. Specific parameters that are defined in your OOS template have default values. When you specify the `NotificationMetadata` parameter, specify parameters that do not have default values. If you specify parameters that have default values, the default values are overwritten. The default values of the following parameters must be retained to obtain information about scaling activities that are in progress:'."\n" + ."\n" + .'* regionId: the region ID of the scaling activity that is in progress. Default value: ${regionId}.'."\n" + ."\n" + .'* instanceIds: the IDs of ECS instances that are scaled in the scaling activity. Default value: ${instanceIds}.'."\n" + ."\n" + .'* lifecycleHookId: the ID of the lifecycle hook. Default value: ${lifecycleHookId}.'."\n" + ."\n" + .'* lifecycleActionToken: the token of the lifecycle hook. You can use the token to end the timeout period of the lifecycle hook ahead of schedule. Default value: ${lifecycleActionToken}'."\n" + ."\n" + .'* scalingGroupId: the ID of the scaling group in which the scaling activity is executed. Default value: ${scalingGroupId}.'."\n" + ."\n" + .'* lifecycleActionResult: the action that Auto Scaling performs after the lifecycle hook times out. If the OOS template fails to be executed, the lifecycle hook times out ahead of schedule. If you set the `DefalutResult` parameter to `ROLLBACK`, the default value of this parameter is `ROLLBACK`. If you set the `DefaultResult` parameter to other values, the default value of this parameter is ABANDON.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note**'."\n" + ."\n" + .' * You can specify a value for the `lifecycleActionResult` parameter to overwrite the default value. Valid values: **ABANDON**, **CONTINUE**, **ROLLBACK**, and **${lifecycleActionResult}**. A value of `${lifecycleActionResult}` specifies that the value of the **lifecycleActionResult** parameter is the same as the value of the **DefaultResult** parameter.'."\n" + .' * You can view the details of the OOS template that you specify in the [OOS console](https://oos.console.aliyun.com/).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test lifecycle hook.', + ], + ], + [ + 'name' => 'NotificationArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notification method. If you do not specify this parameter, no notification is sent when the lifecycle hook takes effect. If you specify this parameter, the following rules apply:'."\n" + ."\n" + .'* If you use an MNS queue as the notification method, specify the value in the acs:mns:{region-id}:{account-id}:queue/{queuename} format.'."\n" + .'* If you use an MNS topic as the notification method, specify the value in the acs:mns:{region-id}:{account-id}:topic/{topicname} format.'."\n" + .'* If you use an OOS template as the notification method, specify the value in the acs:oos:{region-id}:{account-id}:template/{templatename} format.'."\n" + ."\n" + .'The variables in the preceding formats have the following meanings:'."\n" + ."\n" + .'* region-id: the region ID of the scaling group.'."\n" + .'* account-id: the ID of the Alibaba Cloud account. The ID of a RAM user is not supported.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n" + .'* templatename: the name of the OOS template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'LifecycleHookId' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'example' => 'ash-bp1at9ufhmcf9cmy****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"LifecycleHookId\\": \\"ash-bp1at9ufhmcf9cmy****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLifecycleHookResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <LifecycleHookId>ash-bp1at9ufhmcf9cmy****</LifecycleHookId>\\n</CreateLifecycleHookResponse>","errorExample":""}]', + 'title' => 'CreateLifecycleHook', + 'description' => '## Usage notes'."\n" + ."\n" + .'* You can create up to six lifecycle hooks for each scaling group. Elastic Compute Service (ECS) instances are not immediately added to or removed from scaling groups that have effective lifecycle hooks during scaling activities. The ECS instances are added to or removed from the scaling groups only after the lifecycle hooks time out. The period of time before the lifecycle hooks time out is specified by the HeartbeatTimeout parameter. Before lifecycle hooks time out, you can initialize the configurations of ECS instances and query data on the ECS instances.'."\n" + .'* If lifecycle hooks take effect for scale-out activities, the private IP addresses of ECS instances are added to the IP address whitelists of the associated ApsaraDB RDS instances and the ECS instances are added to the backend server groups of the associated Server Load Balancer (SLB) instances only after the lifecycle hooks time out. If lifecycle hooks take effect for scale-in activities, the private IP addresses of ECS instances are removed from the IP address whitelists of the disassociated ApsaraDB RDS instances and the ECS instances are removed from the backend server groups of the disassociated SLB instances only after the lifecycle hooks time out.'."\n" + .'* You can configure a notification method for a lifecycle hook. When the lifecycle hook takes effect, a notification can be sent by using a Message Service (MNS) topic, an MNS queue, or an Operation Orchestration Service (OOS) template. If you want to configure an OOS template, you must create a RAM role for OOS. For more information, see [Grant RAM permissions to OOS](~~120810~~).'."\n" + ."\n" + .'> If your scaling group has existing ECS instances and you configured an OOS template that is used to add private IP addresses of ECS instances to or remove private IP addresses of ECS instances from IP address whitelists of cloud databases that are not ApsaraDB RDS databases, you must manually add the IP addresses to or remove the IP addresses from the IP address whitelists.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteLifecycleHook' => [ + 'summary' => '删除一个生命周期挂钩', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92664', + 'abilityTreeNodes' => [ + 'FEATUREessZQ2TYX', + ], + ], + 'parameters' => [ + [ + 'name' => 'LifecycleHookId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ash-bp14g3ee6bt3sc98****', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'LifecycleHookName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lifecyclehook****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLifecycleHookResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DeleteLifecycleHookResponse>","errorExample":""}]', + 'title' => 'DeleteLifecycleHook', + 'description' => '## Description'."\n" + ."\n" + .'If you delete a lifecycle hook that is in effect in a scaling group, instances are removed from the pending state in advance. You can use one of the following methods to specify the lifecycle hooks that you want to delete:'."\n" + ."\n" + .'* Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.'."\n" + .'* Specify the scaling group ID by using the ScalingGroupId parameter and specify the lifecycle hook name by using the LifecycleHookName parameter.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyLifecycleHook' => [ + 'summary' => '修改一个生命周期挂钩的信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92706', + 'abilityTreeNodes' => [ + 'FEATUREessKFTMD6', + ], + ], + 'parameters' => [ + [ + 'name' => 'LifecycleHookId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lifecycle hook that you want to modify.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ash-bp1fxuqyi98w0aib****', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group to which the lifecycle hook belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'LifecycleHookName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the lifecycle hook that you want to modify.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_SCALE_IN', + ], + ], + [ + 'name' => 'DefaultResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that Auto Scaling performs after the lifecycle hook times out. Valid values:'."\n" + ."\n" + .'* CONTINUE: Auto Scaling continues to respond to a scale-in or scale-out request.'."\n" + .'* ABANDON: Auto Scaling releases Elastic Compute Service (ECS) instances that are created during scale-out activities or removes ECS instances from the scaling group during scale-in activities.'."\n" + .'* ROLLBACK: For scale-in activities, Auto Scaling rejects the requests to release ECS instances but rolls back ECS instances. For scale-out activities, the ROLLBACK setting has the same effect as the ABANDON setting.'."\n" + ."\n" + .'If a scaling group has multiple lifecycle hooks in effect and you set the `DefaultResult` parameter for one of the lifecycle hooks to `ABANDON` or `ROLLBACK`, the following rule applies to scale-in activities: When the lifecycle hook whose **DefaultResult** parameter is set to **ABANDON** or **ROLLBACK** times out, other lifecycle hooks time out ahead of schedule. In other cases, Auto Scaling performs the action only after the last lifecycle hook times out.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTINUE', + ], + ], + [ + 'name' => 'HeartbeatTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The period of time before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that is specified by the **DefaultResult **parameter. Valid values: 30 to 21600. Unit: seconds.'."\n" + ."\n" + .'You can call the [RecordLifecycleActionHeartbeat](~~73846~~) operation to extend the period of time before a lifecycle hook times out. You can also call the [CompleteLifecycleAction](~~73847~~) operation to end a lifecycle hook ahead of schedule.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'LifecycleTransition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the scaling activity to which the lifecycle hook applies. Valid values:'."\n" + ."\n" + .'* SCALE_OUT: scale-out activity'."\n" + .'* SCALE_IN: scale-in activity'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SCALE_IN', + ], + ], + [ + 'name' => 'NotificationMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fixed string that is included in a notification that Auto Scaling sends when the lifecycle hook takes effect. The value of this parameter cannot exceed 4,096 characters in length.'."\n" + ."\n" + .'Auto Scaling sends the value of the `NotificationMetadata` parameter together with the notification. This helps you categorize your notifications. If you specify the `NotificationMetadata` parameter, you must specify the `NotificationArn` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + ], + [ + 'name' => 'NotificationArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notification method.'."\n" + ."\n" + .'* If you use a Message Service (MNS) queue as the notification method, specify the value in the `acs:mns:{region-id}:{account-id}:queue/{queuename}` format.'."\n" + .'* If you use an MNS topic as the notification method, specify the value in the `acs:mns:{region-id}:{account-id}:topic/{topicname}` format.'."\n" + .'* If you use an Operation Orchestration Service (OOS) template as the notification method, specify the value in the `acs:oos:{region-id}:{account-id}:template/{templatename}` format.'."\n" + ."\n" + .'The variables in the preceding formats have the following meanings:'."\n" + ."\n" + .'* region-id: the region ID of the scaling group.'."\n" + .'* account-id: the ID of the Alibaba Cloud account.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n" + .'* templatename: the name of the OOS template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'LifecycleHookStatus', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The status that you want to specify for the lifecycle hook. Valid values: Valid values:'."\n" + ."\n" + .'* Active'."\n" + .'* InActive'."\n" + ."\n" + .'If you do not specify this parameter, the status of the lifecycle hook remains unchanged after you call this operation.'."\n" + ."\n" + .'> By default, a new lifecycle hook is in the **Active** state.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLifecycleHookResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyLifecycleHookResponse>","errorExample":""}]', + 'title' => 'ModifyLifecycleHook', + 'description' => '## Usage notes'."\n" + ."\n" + .'You can use one of the following methods to specify the lifecycle hook that you want to modify:'."\n" + ."\n" + .'* Specify the lifecycle hook ID by using the `LifecycleHookId` parameter. When you use this method, the `ScalingGroupId` and `LifecycleHookName` parameters are ignored.'."\n" + .'* Specify the scaling group ID by using the `ScalingGroupId` parameter and specify the lifecycle hook name by using the `LifecycleHookName` parameter.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeLifecycleActions' => [ + 'summary' => '查看伸缩活动对应的生命周期操作详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92674', + 'abilityTreeNodes' => [ + 'FEATUREess54US0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingActivityId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asa-bp17mug9t0pegagw****', + ], + ], + [ + 'name' => 'LifecycleActionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the lifecycle action. Valid values:'."\n" + ."\n" + .'* Pending: ECS instances enter the Pending state.'."\n" + .'* Timeout: The lifecycle hook times out. ECS instances are automatically removed from the Pending state.'."\n" + .'* Completed: ECS instances are manually removed from the Pending state.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Pending', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to specify the lifecycle action from which the query starts.'."\n" + ."\n" + .'For example, after the first 10 lifecycle actions were queried, the query starts from the 11th lifecycle action. Set this parameter to the NextToken value that is returned in the previous API call. If you do not specify this parameter, the query starts from the beginning.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAcSz4VTb1Nq****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The query token returned in this call.'."\n", + 'type' => 'string', + 'example' => 'AAAAAcSz4VTb1Nq****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '42A742EB-FCF3-459E-9C62-E107048C17E3', + ], + 'TotalCount' => [ + 'description' => 'The total number of queried lifecycle actions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'LifecycleActions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LifecycleAction' => [ + 'description' => 'The lifecycle actions that correspond to each lifecycle hook.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LifecycleHookId' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'example' => 'ash-bp18uoft0deax0f7****', + ], + 'LifecycleActionToken' => [ + 'description' => 'The token of the lifecycle action.'."\n", + 'type' => 'string', + 'example' => '9C2E9DA7-F794-449A-ACF6-CEE24444F7BB', + ], + 'LifecycleActionStatus' => [ + 'description' => 'The status of the lifecycle action.'."\n", + 'type' => 'string', + 'example' => 'Pending', + ], + 'LifecycleActionResult' => [ + 'description' => 'The action that is performed after the lifecycle action triggered by the lifecycle hook is complete. Valid values:'."\n" + ."\n" + .'* CONTINUE: Auto Scaling continues to respond to scale-out requests and adds ECS instances to the scaling group, or continues to respond to scale-in requests and removes ECS instances from the scaling group.'."\n" + .'* ABANDON: Auto Scaling stops scale-out activities and releases the created ECS instances, or continues to respond to scale-in requests and removes ECS instances from the scaling group.'."\n", + 'type' => 'string', + 'example' => 'CONTINUE', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The IDs of the ECS instances to which the lifecycle hook applies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the ECS instances.'."\n", + 'type' => 'string', + 'example' => '["i-bp11m3fzlqrgk5vh****","i-bp11m3fzlqrgk5vh****"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAcSz4VTb1Nq****\\",\\n \\"RequestId\\": \\"42A742EB-FCF3-459E-9C62-E107048C17E3\\",\\n \\"TotalCount\\": 3,\\n \\"MaxResults\\": 3,\\n \\"LifecycleActions\\": {\\n \\"LifecycleAction\\": [\\n {\\n \\"LifecycleHookId\\": \\"ash-bp18uoft0deax0f7****\\",\\n \\"LifecycleActionToken\\": \\"9C2E9DA7-F794-449A-ACF6-CEE24444****\\",\\n \\"LifecycleActionStatus\\": \\"Pending\\",\\n \\"LifecycleActionResult\\": \\"CONTINUE\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"[\\\\\\"i-bp11m3fzlqrgk5vh****\\\\\\",\\\\\\"i-bp11m3fzlqrgk5vh****\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLifecycleActionsResponse>\\n <NextToken>AAAAAcSz4VTb1Nq****</NextToken>\\n <RequestId>42A742EB-FCF3-459E-9C62-E107048C17E3</RequestId>\\n <TotalCount>3</TotalCount>\\n <MaxResults>3</MaxResults>\\n <LifecycleActions>\\n <LifecycleHookId>ash-bp18uoft0deax0f7****</LifecycleHookId>\\n <LifecycleActionToken>9C2E9DA7-F794-449A-ACF6-CEE24444F7BB</LifecycleActionToken>\\n <LifecycleActionStatus>Pending</LifecycleActionStatus>\\n <LifecycleActionResult>CONTINUE</LifecycleActionResult>\\n <InstanceIds>[\\"i-bp11m3fzlqrgk5vh****\\",\\"i-bp11m3fzlqrgk5vh****\\"]</InstanceIds>\\n </LifecycleActions>\\n</DescribeLifecycleActionsResponse>","errorExample":""}]', + 'title' => 'DescribeLifecycleActions', + 'description' => '## Description'."\n" + ."\n" + .'If a scaling activity whose type is the same as the type of a lifecycle hook occurs, the lifecycle hook triggers a lifecycle action. The status of a lifecycle action can be:'."\n" + ."\n" + .'* Pending: Elastic Compute Service (ECS) instances in the scaling group enter the Pending state.'."\n" + .'* Timeout: The lifecycle hook times out. ECS instances in the scaling group are automatically removed from the Pending state.'."\n" + .'* Completed: ECS instances are manually removed from the Pending state.'."\n" + ."\n" + .'If you do not specify the subsequent actions when you create a lifecycle hook, such as triggering the execution of a specific Operation Orchestration Service (OOS) template after the ECS instances are removed from the Pending state, you can call this operation to obtain the token of the lifecycle action that corresponds to the scaling activity. This helps you specify the subsequent actions.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeLifecycleHooks' => [ + 'summary' => '查询生命周期挂钩详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92675', + 'abilityTreeNodes' => [ + 'FEATUREess54US0Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'LifecycleHookName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lifecyclehook****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'LifecycleHookId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of lifecycle hook N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ash-bp1at9ufhmcf9cmy****', + ], + 'required' => false, + 'example' => 'ash-bp19d1032y9kij96****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of lifecycle hooks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LifecycleHooks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LifecycleHook' => [ + 'description' => 'Details of the lifecycle hooks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DefaultResult' => [ + 'description' => 'The action that Auto Scaling performs when the lifecycle hook times out.'."\n", + 'type' => 'string', + 'example' => 'CONTINUE', + ], + 'LifecycleHookId' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'example' => 'ash-bp19d1032y9kij96****', + ], + 'LifecycleHookName' => [ + 'description' => 'The name of the lifecycle hook.'."\n", + 'type' => 'string', + 'example' => 'lifecyclehook****', + ], + 'LifecycleTransition' => [ + 'description' => 'The type of the scaling activity to which the lifecycle hook applies.'."\n", + 'type' => 'string', + 'example' => 'SCALE_OUT', + ], + 'NotificationMetadata' => [ + 'description' => 'The fixed string that is included in a notification. Auto Scaling sends the notification when the lifecycle hook takes effect.'."\n", + 'type' => 'string', + 'example' => 'Test Lifecycle Hook.', + ], + 'NotificationArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the method that is used by Auto Scaling to send notifications when the lifecycle hook takes effect. Specify the value in one of the following formats:'."\n" + ."\n" + .'* If you do not create a notification rule, specify the value in the `acs:ess:{region-id}:{account-id}:null/null` format.'."\n" + .'* If you specify a Message Service (MNS) queue as the notification method, specify the value in the `acs:mns:{region-id}:{account-id}:queue/{queuename}` format.'."\n" + .'* If you specify an MNS topic as the notification method, specify the value in the `acs:mns:{region-id}:{account-id}:topic/{topicname}` format.'."\n" + .'* If you specify an Operation Orchestration Service (OOS) template as the notification method, specify the value in the `acs:oos:{region-id}:{account-id}:template/{templatename}` format.'."\n" + ."\n" + .'The variables in the preceding parameter formats have the following meanings:'."\n" + ."\n" + .'* region-id: the region ID of the scaling group.'."\n" + .'* account-id: the ID of the Alibaba Cloud account.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n" + .'* templatename: the name of the OOS template.'."\n", + 'type' => 'string', + 'example' => 'acs:ess:cn-beijing:161456884340****:null/null', + ], + 'HeartbeatTimeout' => [ + 'description' => 'The period of time during which the lifecycle hook is in effect. Auto Scaling performs the default action when the lifecycle hook times out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + 'LifecycleHookStatus' => [ + 'description' => 'The status of the lifecycle hook. Valid values:'."\n" + ."\n" + .'* Active'."\n" + .'* InActive'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 1,\\n \\"LifecycleHooks\\": {\\n \\"LifecycleHook\\": [\\n {\\n \\"DefaultResult\\": \\"CONTINUE\\",\\n \\"LifecycleHookId\\": \\"ash-bp19d1032y9kij96****\\",\\n \\"LifecycleHookName\\": \\"lifecyclehook****\\",\\n \\"LifecycleTransition\\": \\"SCALE_OUT\\",\\n \\"NotificationMetadata\\": \\"Test Lifecycle Hook.\\",\\n \\"NotificationArn\\": \\"acs:ess:cn-beijing:161456884340****:null/null\\",\\n \\"HeartbeatTimeout\\": 60,\\n \\"ScalingGroupId\\": \\"asg-bp1igpak5ft1flyp****\\",\\n \\"LifecycleHookStatus\\": \\"Active\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLifecycleHooksResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>50</PageSize>\\n <TotalCount>1</TotalCount>\\n <LifecycleHooks>\\n <DefaultResult>CONTINUE</DefaultResult>\\n <LifecycleHookId>ash-bp19d1032y9kij96****</LifecycleHookId>\\n <LifecycleHookName>lifecyclehook****</LifecycleHookName>\\n <LifecycleTransition>SCALE_OUT</LifecycleTransition>\\n <NotificationMetadata>Test Lifecycle Hook.</NotificationMetadata>\\n <NotificationArn>acs:ess:cn-beijing:161456884340****:null/null</NotificationArn>\\n <HeartbeatTimeout>60</HeartbeatTimeout>\\n <ScalingGroupId>asg-bp1igpak5ft1flyp****</ScalingGroupId>\\n <LifecycleHookStatus>Active</LifecycleHookStatus>\\n </LifecycleHooks>\\n</DescribeLifecycleHooksResponse>","errorExample":""}]', + 'title' => 'DescribeLifecycleHooks', + 'description' => '## Description'."\n" + ."\n" + .'You can use one of the following methods to query lifecycle hooks:'."\n" + ."\n" + .'* Specify a list of lifecycle hook IDs by using the LifecycleHookId.N parameter. In this case, you do not need to specify the ScalingGroupId and LifecycleHookName parameters.'."\n" + .'* Specify the scaling group ID by using the ScalingGroupId parameter.'."\n" + .'* Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'RecordLifecycleActionHeartbeat' => [ + 'summary' => '延长生命周期挂钩触发后ECS实例被挂起等待时间', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92713', + 'abilityTreeNodes' => [ + 'FEATUREessKFTMD6', + ], + ], + 'parameters' => [ + [ + 'name' => 'lifecycleHookId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ash-bp1fxuqyi98w0aib****', + ], + ], + [ + 'name' => 'lifecycleActionToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that indicates the pending state of a scaling activity. You can obtain this token by using a Message Service (MNS) queue or an MNS topic that is specified for the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'F324B880-900E-4968-85DD-81691113****', + ], + ], + [ + 'name' => 'heartbeatTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period of the lifecycle hook. When the lifecycle hook times out, Auto Scaling performs the default action. Unit: seconds. Valid values: 30 to 21600.'."\n" + ."\n" + .'After you create a lifecycle hook, you can call the RecordLifecycleActionHeartbeat operation to extend the timeout period of the lifecycle hook. You can also call the [CompleteLifecycleAction](~~73847~~) operation to end the timeout period of the lifecycle hook in advance.'."\n" + ."\n" + .'Default value: 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<RecordLifecycleActionHeartbeatResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</RecordLifecycleActionHeartbeatResponse>","errorExample":""}]', + 'title' => 'RecordLifecycleActionHeartbeat', + 'description' => '## Description'."\n" + ."\n" + .'You can call the operation up to 20 times to extend the timeout period of a lifecycle hook. However, the total length of the timeout period cannot exceed 6 hours because an ECS instance cannot be in the pending state for more than 6 hours.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CompleteLifecycleAction' => [ + 'summary' => '提前结束伸缩活动的等待状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92652', + 'abilityTreeNodes' => [ + 'FEATUREessKFTMD6', + ], + ], + 'parameters' => [ + [ + 'name' => 'LifecycleHookId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ash-bp14g3ee6bt3sc98****', + ], + ], + [ + 'name' => 'LifecycleActionToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token of the lifecycle hook. You can obtain the token by using a Message Service (MNS) queue or an MNS topic that is specified for the lifecycle hook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aaaa-bbbbb-cccc-ddddd', + ], + ], + [ + 'name' => 'LifecycleActionResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action that you want Auto Scaling to perform after the lifecycle hook times out. Valid values:'."\n" + ."\n" + .'* CONTINUE: Auto Scaling continues to respond to a scale-in or scale-out request.'."\n" + .'* ABANDON: Auto Scaling releases Elastic Compute Service (ECS) instances that are created during scale-out activities or removes ECS instances from the scaling group during scale-in activities.'."\n" + .'* ROLLBACK: For scale-in activities, Auto Scaling rejects the requests to release ECS instances but rolls back ECS instances. For scale-out activities, the ROLLBACK setting has the same effect as the ABANDON setting.'."\n" + ."\n" + .'If you do not specify this parameter, Auto Scaling performs the action that is specified by the `DefaultResult` parameter after the lifecycle hook times out.'."\n" + ."\n" + .'If multiple lifecycle hooks exist in a scaling group and the lifecycle hooks are triggered at the same time, the following rules apply:'."\n" + ."\n" + .'* For scale-in activities, when lifecycle hooks whose LifecycleActionResult parameter is set to `ABANDON` or `ROLLBACK` time out, other lifecycle hooks time out ahead of schedule.'."\n" + .'* For scale-in and scale-out activities, if you set the LifecycleActionResult parameter for all lifecycle hooks to `CONTINUE`, Auto Scaling performs the subsequent action only after the last lifecycle hook times out. The action that is performed by Auto Scaling varies based on the value that you specified for the LifecycleActionResult parameter of the last lifecycle hook that times out.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTINUE', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" + ."\n" + .'The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<CompleteLifecycleActionResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</CompleteLifecycleActionResponse>","errorExample":""}]', + 'title' => 'CompleteLifecycleAction', + 'description' => '## Usage notes'."\n" + ."\n" + .'If you set the **LifecycleActionResult** parameter for a lifecycle hook of a scaling group to **CONTINUE** in the operation, Auto Scaling continues to complete the scaling activity in the scaling group after the lifecycle hook times out. If you set the **LifecycleActionResult** parameter to **ABANDON**, Auto Scaling stops the scaling activity in the scaling group after the lifecycle hook times out.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CreateNotificationConfiguration' => [ + 'summary' => '创建弹性伸缩事件及资源变化通知', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92656', + 'abilityTreeNodes' => [ + 'FEATUREess6E26FJ', + 'FEATUREessFY8KDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'NotificationArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notified party. The following list describes the value formats of this parameter:'."\n" + ."\n" + .'* If the notified party is CloudMonitor, the value format of this parameter is acs:ess:{region-id}:{account-id}:cloudmonitor.'."\n" + .'* If the notified party is an MNS queue, the value format of this parameter is acs:mns:{region-id}:{account-id}:queue/{queuename}.'."\n" + .'* If the notified party is an MNS topic, the value format of this parameter is acs:mns:{region-id}:{account-id}:topic/{topicname}.'."\n" + ."\n" + .'The variables in the preceding formats have the following meanings:'."\n" + ."\n" + .'* region-id: the region ID of the scaling group.'."\n" + .'* account-id: the ID of the Alibaba Cloud account.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo****', + ], + ], + [ + 'name' => 'NotificationType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The type of notification N for scaling activities or resource changes. Valid values of N: 1 to 8. Specify multiple values in the repeated list form.'."\n" + ."\n" + .'You can call the [DescribeNotificationTypes](~~71117~~) operation to query the values of this parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of notification N for scaling activities or resource changes. Valid values of N: 1 to 8. Specify multiple values in the repeated list form.'."\n" + ."\n" + .'You can call the [DescribeNotificationTypes](~~71117~~) operation to query the values of this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AUTOSCALING:SCALE_OUT_SUCCESS', + ], + 'required' => true, + 'example' => 'AUTOSCALING:SCALE_OUT_SUCCESS', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TimeZone', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'MessageEncoding', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateNotificationConfigurationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</CreateNotificationConfigurationResponse>","errorExample":""}]', + 'title' => 'CreateNotificationConfiguration', + 'description' => '## Description'."\n" + ."\n" + .'You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling activity or resource change occurs in a scaling group, Auto Scaling notifies CloudMonitor or MNS.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteNotificationConfiguration' => [ + 'summary' => '删除一条弹性伸缩事件及资源变化通知', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92665', + 'abilityTreeNodes' => [ + 'FEATUREessJ2FJEV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'NotificationArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notified party. The following list describes the value formats of this parameter:'."\n" + ."\n" + .'* If the notified party is CloudMonitor, the value format of this parameter is acs:ess:{region-id}:{account-id}:cloudmonitor.'."\n" + .'* If the notified party is a Message Service (MNS) queue, the value format of this parameter is acs:mns:{region-id}:{account-id}:queue/{queuename}.'."\n" + .'* If the notified party is an MNS topic, the value format of this parameter is acs:mns:{region-id}:{account-id}:topic/{topicname}.'."\n" + ."\n" + .'The variables in the preceding formats have the following meanings:'."\n" + ."\n" + .'* region-id: the region ID of the scaling group.'."\n" + .'* account-id: the ID of the Alibaba Cloud account.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ess:cn-beijing:161456884340****:cloudmonitor', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteNotificationConfigurationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</DeleteNotificationConfigurationResponse>","errorExample":""}]', + 'title' => 'DeleteNotificationConfiguration', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DeleteNotificationConfiguration\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyNotificationConfiguration' => [ + 'summary' => '修改一条弹性伸缩事件及资源变化通知', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92707', + 'abilityTreeNodes' => [ + 'FEATUREess6E26FJ', + 'FEATUREessFY8KDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'NotificationArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notified party. The following list describes the value formats of this parameter:'."\n" + ."\n" + .'* If the notified party is CloudMonitor, the value format of this parameter is acs:ess:{region-id}:{account-id}:cloudmonitor.'."\n" + .'* If the notified party is a Message Service (MNS) queue, the value format of this parameter is acs:mns:{region-id}:{account-id}:queue/{queuename}.'."\n" + .'* If the notified party is an MNS topic, the value format of this parameter is acs:mns:{region-id}:{account-id}:topic/{topicname}.'."\n" + ."\n" + .'The variables in the preceding formats have the following meanings:'."\n" + ."\n" + .'* region-id: the ID of the region where the scaling group resides.'."\n" + .'* account-id: the ID of the Alibaba Cloud account.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ess:cn-beijing:161456884340****:cloudmonitor', + ], + ], + [ + 'name' => 'NotificationType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The type of notification N for scaling activities or resource changes. Valid values of N: 1 to 8. Specify multiple values in the repeated list form.'."\n" + ."\n" + .'You can call the [DescribeNotificationTypes](~~71117~~) operation to query the value of this parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of notification N for scaling activities or resource changes. Valid values of N: 1 to 8. Specify multiple values in the repeated list form.'."\n" + ."\n" + .'You can call the [DescribeNotificationTypes](~~71117~~) operation to query the value of this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AUTOSCALING:SCALE_OUT_SUCCESS', + ], + 'required' => true, + 'example' => 'AUTOSCALING:SCALE_OUT_SUCCESS', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TimeZone', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'MessageEncoding', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyNotificationConfigurationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyNotificationConfigurationResponse>","errorExample":""}]', + 'title' => 'ModifyNotificationConfiguration', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=ModifyNotificationConfiguration\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeNotificationConfigurations' => [ + 'summary' => '查询弹性伸缩事件及资源变化通知', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92677', + 'abilityTreeNodes' => [ + 'FEATUREess6E26FJ', + 'FEATUREessFY8KDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'NotificationConfigurationModels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NotificationConfigurationModel' => [ + 'description' => 'The details of the notifications for scaling activities or resource changes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the notified party. The following list describes the value formats of this parameter:'."\n" + ."\n" + .'* If the notified party is CloudMonitor, the value format is acs:ess:{region-id}:{account-id}:cloudmonitor.'."\n" + .'* If the notified party is a Message Service (MNS) queue, the value format is acs:mns:{region-id}:{account-id}:queue/{queuename}.'."\n" + .'* If the notified party is an MNS topic, the value format is acs:mns:{region-id}:{account-id}:topic/{topicname}.'."\n" + ."\n" + .'The variables in the preceding formats have the following meanings:'."\n" + ."\n" + .'* region-id: the region ID of the scaling group.'."\n" + .'* account-id: the ID of the Alibaba Cloud account.'."\n" + .'* queuename: the name of the MNS queue.'."\n" + .'* topicname: the name of the MNS topic.'."\n", + 'type' => 'string', + 'example' => 'acs:mns:cn-beijing:161456884340****:topic/modifyLifecycleHo****', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + 'NotificationTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NotificationType' => [ + 'description' => 'The types of notifications for scaling activities or resource changes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The types of notifications for scaling activities or resource changes.', + 'type' => 'string', + 'example' => 'AUTOSCALING:SCALE_IN_SUCCESS', + ], + ], + ], + ], + 'TimeZone' => [ + 'type' => 'string', + ], + 'MessageEncoding' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"NotificationConfigurationModels\\": {\\n \\"NotificationConfigurationModel\\": [\\n {\\n \\"NotificationArn\\": \\"acs:mns:cn-beijing:161456884340****:topic/modifyLifecycleHo****\\",\\n \\"ScalingGroupId\\": \\"asg-bp1igpak5ft1flyp****\\",\\n \\"NotificationTypes\\": {\\n \\"NotificationType\\": [\\n \\"AUTOSCALING:SCALE_IN_SUCCESS\\"\\n ]\\n },\\n \\"TimeZone\\": \\"UTC+8\\",\\n \\"MessageEncoding\\": \\"PlainText\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeNotificationConfigurationsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <NotificationConfigurationModels>\\n <NotificationArn>acs:mns:cn-beijing:161456884340****:topic/modifyLifecycleHo****</NotificationArn>\\n <ScalingGroupId>asg-bp1igpak5ft1flyp****</ScalingGroupId>\\n <NotificationTypes>AUTOSCALING:SCALE_IN_SUCCESS</NotificationTypes>\\n </NotificationConfigurationModels>\\n</DescribeNotificationConfigurationsResponse>","errorExample":""}]', + 'title' => 'DescribeNotificationConfigurations', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeNotificationConfigurations\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeNotificationTypes' => [ + 'summary' => '查询弹性伸缩事件及资源变化通知的类型', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92678', + 'abilityTreeNodes' => [ + 'FEATUREessFY8KDA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'NotificationTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NotificationType' => [ + 'description' => 'The types of notifications for scaling activities and resource changes.'."\n" + ."\n" + .'* AUTOSCALING:SCALE_OUT_SUCCESS: The scale-out event is successful.'."\n" + .'* AUTOSCALING:SCALE_IN_SUCCESS: The scale-in event is successful.'."\n" + .'* AUTOSCALING:SCALE_OUT_ERROR: The scale-out event fails.'."\n" + .'* AUTOSCALING:SCALE_IN_ERROR: The scale-in event fails.'."\n" + .'* AUTOSCALING:SCALE_REJECT: The scaling activity is rejected.'."\n" + .'* AUTOSCALING:SCALE_OUT_START: The scale-out event is started.'."\n" + .'* AUTOSCALING:SCALE_IN_START: The scale-in event is started.'."\n" + .'* AUTOSCALING:SCHEDULE_TASK_EXPIRING: Auto Scaling sends a notification when a scheduled task is about to expire.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The types of notifications for scaling activities and resource changes.'."\n" + ."\n" + .'* AUTOSCALING:SCALE_OUT_SUCCESS: The scale-out event is successful.'."\n" + .'* AUTOSCALING:SCALE_IN_SUCCESS: The scale-in event is successful.'."\n" + .'* AUTOSCALING:SCALE_OUT_ERROR: The scale-out event fails.'."\n" + .'* AUTOSCALING:SCALE_IN_ERROR: The scale-in event fails.'."\n" + .'* AUTOSCALING:SCALE_REJECT: The scaling activity is rejected.'."\n" + .'* AUTOSCALING:SCALE_OUT_START: The scale-out event is started.'."\n" + .'* AUTOSCALING:SCALE_IN_START: The scale-in event is started.'."\n" + .'* AUTOSCALING:SCHEDULE_TASK_EXPIRING: Auto Scaling sends a notification when a scheduled task is about to expire.', + 'type' => 'string', + 'example' => 'AUTOSCALING:SCALE_OUT_SUCCESS', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"NotificationTypes\\": {\\n \\"NotificationType\\": [\\n \\"AUTOSCALING:SCALE_OUT_SUCCESS\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeNotificationTypesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <NotificationTypes>AUTOSCALING:SCALE_OUT_SUCCESS</NotificationTypes>\\n</DescribeNotificationTypesResponse>","errorExample":""}]', + 'title' => 'DescribeNotificationTypes', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeNotificationTypes\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetInstancesProtection' => [ + 'summary' => '开始或停止保护伸缩组内ECS实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92719', + 'abilityTreeNodes' => [ + 'FEATUREessBFHJ1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ProtectedFromScaleIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable protection for an ECS instance to prevent the ECS instance from being stopped or removed from the scaling group during scale-in events. Valid values:'."\n" + ."\n" + .'* true: enables protection for the ECS instance.'."\n" + .'* false: disables protection for the ECS instance.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of ECS instance N. Valid values of N: 1 to 20.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of ECS instance N. Valid values of N: 1 to 20.'."\n", + 'example' => 'i-28wt4****', + ], + 'required' => true, + 'example' => 'i-28wt4****', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetInstancesProtectionResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</SetInstancesProtectionResponse>","errorExample":""}]', + 'title' => 'SetInstancesProtection', + 'description' => '## Description'."\n" + ."\n" + .'After an ECS instance is put into the Protected state, the following limits apply to the instance:'."\n" + ."\n" + .'* The instance remains in the Protected state until you remove the instance from the Protected state.'."\n" + .'* Even if a scale-in event is triggered for a scaling group due to a change in the number of ECS instances or due to an event-triggered task, Auto Scaling does not remove the ECS instances in the Protected state. You must remove the ECS instance from the Protected state before Auto Scaling can remove the ECS instance from the scaling group and release the instance. For information about how to remove an ECS instance from a scaling group, see [Remove an ECS instance from a scaling group](~~25955~~).'."\n" + .'* When the ECS instance is stopped or restarted, the health status of the instance remains unchanged.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SetInstanceHealth' => [ + 'summary' => '设置伸缩组内ECS实例的健康状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92718', + 'abilityTreeNodes' => [ + 'FEATUREessBFHJ1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of an ECS instance in a scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp1ap6bro51a7fsa****', + ], + ], + [ + 'name' => 'HealthStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The health status of an ECS instance. Valid values:'."\n" + ."\n" + .'* Healthy'."\n" + .'* Unhealthy'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Healthy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B755AE57-6093-43E4-938E-DEA422A9B10F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B755AE57-6093-43E4-938E-DEA422A9****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetInstanceHealthResponse>\\n <RequestId>B755AE57-6093-43E4-938E-DEA422A9****</RequestId>\\n</SetInstanceHealthResponse>","errorExample":""}]', + 'title' => 'SetInstanceHealth', + 'description' => '## Description'."\n" + ."\n" + .'Auto Scaling performs health checks on ECS instances in a scaling group and removes unhealthy ECS instances. If you want to reserve an ECS instance, you can switch the ECS instance to the Standby or Protected state. For more information, see [EnterStandby](~~69678~~) and [SetInstancesProtection](~~71517~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'EnterStandby' => [ + 'summary' => '将伸缩组内的ECS实例设置为备用状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92697', + 'abilityTreeNodes' => [ + 'FEATUREessBFHJ1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1fo0dbtsbmqa9h****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n" + ."\n" + .'The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of ECS instance N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-28wt4****', + ], + 'required' => true, + 'example' => 'i-28wt4****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to put the ECS instance into the Standby state in an asynchronous manner. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'ScalingActivityId' => [ + 'title' => '异步调用伸缩活动ID', + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-2zeb04oym05qaceq****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ScalingActivityId\\": \\"asa-2zeb04oym05qaceq****\\"\\n}","errorExample":""},{"type":"xml","example":"<EnterStandbyResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ScalingActivityId>asa-2zeb04oym05qaceq****</ScalingActivityId>\\n</EnterStandbyResponse>","errorExample":""}]', + 'title' => 'EnterStandby', + 'description' => '## Description'."\n" + ."\n" + .'* If you call the operation to put an ECS instance in a scaling group that is associated with a Server Load Balancer (SLB) instance into the Standby state, the weight of the ECS instance as the backend server of the SLB instance is set to 0.'."\n" + .'* You can remove an instance that is in the Standby state from a scaling group, and then release the instance.'."\n" + .'* ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.'."\n" + .'* If Auto Scaling considers an ECS instance that is in the Standby state unhealthy, for example, the ECS instance is being stopped or being restarted, Auto Scaling does not update the health status of the ECS instance or trigger scale-in activities to remove the ECS instance from the scaling group. Auto Scaling updates the health status of the ECS instance only when the ECS instance is no longer in the Standby state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ExitStandby' => [ + 'summary' => '使备用状态实例进入运行状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92699', + 'abilityTreeNodes' => [ + 'FEATUREessBFHJ1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1fo0dbtsbmqa9h****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n" + ."\n" + .'The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of ECS instance N. The value of this parameter can be a JSON array that consists of up to 20 instance IDs. Separate multiple instance IDs with commas (,).', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of ECS instance N. The value of this parameter can be a JSON array that consists of up to 20 instance IDs. Separate multiple instance IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-28wt4****', + ], + 'required' => true, + 'example' => 'i-28wt4****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to asynchronously remove the ECS instance from the Standby state. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'ScalingActivityId' => [ + 'title' => '异步调用伸缩活动ID', + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-2zeb04oym05qaceq****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ScalingActivityId\\": \\"asa-2zeb04oym05qaceq****\\"\\n}","errorExample":""},{"type":"xml","example":"<ExitStandbyResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ScalingActivityId>asa-2zeb04oym05qaceq****</ScalingActivityId>\\n</ExitStandbyResponse>","errorExample":""}]', + 'title' => 'ExitStandby', + 'description' => '## Description'."\n" + ."\n" + .'If a scaling group is associated with Server Load Balancer (SLB) instances, the weight of the ECS instance in the scaling group is set to the value that is specified in the scaling configuration when the ECS instance is removed from the Standby state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'RebalanceInstances' => [ + 'summary' => '重新平衡ECS实例分布', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92712', + 'abilityTreeNodes' => [ + 'FEATUREessPV8ZVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-kjgffgdfadah****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-kjgffgdfadah****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<RebalanceInstancesResponse>\\n <ScalingActivityId>asa-kjgffgdfadah****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</RebalanceInstancesResponse>","errorExample":""}]', + 'title' => 'RebalanceInstances', + 'description' => '## Description'."\n" + ."\n" + .'To rebalance ECS instances in a multiple-zone scaling group, Auto Scaling creates ECS instances to replace the existing instances. Auto Scaling starts the created instances before it terminates the existing instances. This ensures that the performance and availability of your applications are not affected.'."\n" + ."\n" + .'* You can call this operation only if you set the MultiAZPolicy parameter of the multi-zone scaling group to BALANCE.'."\n" + .'* You can rebalance ECS instances in a scaling group only when the distribution of ECS instances in the scaling group is significantly imbalanced.'."\n" + .'* You can replace up to 20 ECS instances during a rebalancing activity.'."\n" + .'* If the number of ECS instances in the scaling group approaches or reaches the maximum number of instances that is specified by the MaxSize parameter during a rebalancing activity and the rebalancing activity must continue, Auto Scaling allows the number of ECS instances in the scaling group to temporarily exceed the maximum number. The excess number of instances ranges from one to 10% of the value of the MaxSize parameter. In most cases, Auto Scaling requires one to six minutes to rebalance the instances in the scaling group when the number of instances in the scaling group exceeds the maximum number.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries regions. Before you activate Auto Scaling, you can call the DescribeRegions operation to query the regions where Auto Scaling is officially launched.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92679', + 'abilityTreeNodes' => [ + 'FEATUREessZ1KWHS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language that is used as a filter condition to filter returned results. For more information, see [RFC 7231](https://tools.ietf.org/html/rfc7231). Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese'."\n" + .'* en-US: English'."\n" + .'* ja: Japanese'."\n" + ."\n" + .'Default value: zh-CN.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Details of the regions.', + 'type' => 'string', + 'example' => '73469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'Details about the regions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClassicUnavailable' => [ + 'description' => 'Indicates whether the region supports scaling groups of the classic network type. Valid values:'."\n" + ."\n" + .'* true: The region does not support scaling groups of the classic network type.'."\n" + .'* false: The region supports scaling groups of the classic network type.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the region.'."\n", + 'type' => 'string', + 'example' => 'ess.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcUnavailable' => [ + 'description' => 'Indicates whether the region supports scaling groups of the VPC type. Valid values:'."\n" + ."\n" + .'* true: The region does not support scaling groups of the VPC type.'."\n" + .'* false: The region supports scaling groups of the VPC type.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"ClassicUnavailable\\": false,\\n \\"RegionEndpoint\\": \\"ess.aliyuncs.com\\",\\n \\"LocalName\\": \\"华北2 (北京)\\",\\n \\"VpcUnavailable\\": false,\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>73469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <Regions>\\n <ClassicUnavailable>false</ClassicUnavailable>\\n <RegionEndpoint>ess.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2 (北京)</LocalName>\\n <VpcUnavailable>false</VpcUnavailable>\\n <RegionId>cn-beijing</RegionId>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeRegions\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListTagResources' => [ + 'summary' => '查询弹性伸缩资源已经绑定的标签列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92701', + 'abilityTreeNodes' => [ + 'FEATUREess7569XW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the resource. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Only scaling groups are supported. Set the value to scalinggroup.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'scalinggroup', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used for the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of resource N. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of resource N. Valid values of N: 1 to 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp17xb4x1vr29lgt****', + ], + 'required' => false, + 'example' => 'asg-bp17xb4x1vr29lgt****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N. The key is used to perform an exact match of Auto Scaling resources. The key must be 1 to 128 characters in length. Valid values of N: 1 to 20.'."\n" + ."\n" + .'`Tag.N` is used to perform an exact match of Auto Scaling resources to which the specified tags are added. Tag.N consists of one key-value pair.'."\n" + ."\n" + .'* If you specify only `Tag.N.Key`, all resources whose tags contain the specified tag key are returned.'."\n" + .'* If you specify only `Tag.N.Value`, the `MissingParameter.TagKey` error is returned.'."\n" + .'* If you specify multiple key-value pairs at the same time, only Auto Scaling resources that match all the tag keys and tag values are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The value of tag N. The value is used to perform an exact match of Auto Scaling resources. The tag value can be an empty string, and it can be up to 128 characters in length. Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is returned for the next query.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DE65F6B7-7566-4802-9007-96F2494A****', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The details of resources and tags, including resource IDs, resource types, and tag key-value pairs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'TestValue', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN::ESS::SCALINGGROUP', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'asg-bp17xb4x1vr29lgt****', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Propagate' => [ + 'description' => 'Indicates whether the tag can be propagated.'."\n" + ."\n" + .'* true: The tag can be propagated only to instances that are to be added to the scaling group. The tag cannot be propagated to instances that are already running in the scaling group.'."\n" + .'* false: The tag cannot be propagated to an instance.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"DE65F6B7-7566-4802-9007-96F2494A****\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceType\\": \\"ALIYUN::ESS::SCALINGGROUP\\",\\n \\"ResourceId\\": \\"asg-bp17xb4x1vr29lgt****\\",\\n \\"TagKey\\": \\"TestKey\\",\\n \\"Propagate\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>DE65F6B7-7566-4802-9007-96F2494A****</RequestId>\\n <TagResources>\\n <TagValue>TestValue</TagValue>\\n <ResourceType>ALIYUN::ESS::SCALINGGROUP</ResourceType>\\n <ResourceId>asg-bp17xb4x1vr29lgt****</ResourceId>\\n <TagKey>TestKey</TagKey>\\n <Propagate>false</Propagate>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + 'description' => '## Description'."\n" + ."\n" + .'* Specify `ResourceId.N` or `Tag.N` that consists of `Tag.N.Key` and `Tag.N.Value` in the request to specify the objects that you want to query.'."\n" + .'* If you specify `Tag.N` and `ResourceId.N` at the same time, the Auto Scaling resources that match both the parameters are returned.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagKeys' => [ + 'summary' => '查询弹性伸缩资源标签键的列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92700', + 'abilityTreeNodes' => [ + 'FEATUREess7569XW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the Auto Scaling resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the Auto Scaling resource. Set the value to scalinggroup, which indicates that the tag is bound to a scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'scalinggroup', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query. If the NextToken parameter is empty, no subsequent requests are sent.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to start the next query. If the NextToken parameter is empty, no subsequent requests are sent.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC09A6AA-2713-4E10-A2E9-E6C5C43A8842', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Keys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Key' => [ + 'description' => 'The information of the tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tag keys.', + 'type' => 'string', + 'example' => 'ESS', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"DC09A6AA-2713-4E10-A2E9-E6C5C43A****\\",\\n \\"PageSize\\": 10,\\n \\"Keys\\": {\\n \\"Key\\": [\\n \\"ESS\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagKeysResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <RequestId>DC09A6AA-2713-4E10-A2E9-E6C5C43A8842</RequestId>\\n <PageSize>10</PageSize>\\n <Keys>ESS</Keys>\\n</ListTagKeysResponse>","errorExample":""}]', + 'title' => 'ListTagKeys', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=ListTagKeys\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListTagValues' => [ + 'summary' => '查询弹性伸缩资源标签键对应的标签值', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92702', + 'abilityTreeNodes' => [ + 'FEATUREess7569XW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the Auto Scaling resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the Auto Scaling resource. Set the value to scalinggroup, which indicates that the tag is bound to a scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'scalinggroup', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to start the next query. If the NextToken parameter is empty, no subsequent requests are sent.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ESS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to start the next query. If the NextToken parameter is empty, no subsequent requests are sent.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AB444F46-1CFF-4B06-B8F0-B45D3158F95B', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Value' => [ + 'description' => 'The information of the tag values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information of the tag values.', + 'type' => 'string', + 'example' => 'Doc', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"AB444F46-1CFF-4B06-B8F0-B45D3158****\\",\\n \\"PageSize\\": 10,\\n \\"Values\\": {\\n \\"Value\\": [\\n \\"Doc\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagValuesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <RequestId>AB444F46-1CFF-4B06-B8F0-B45D3158****</RequestId>\\n <PageSize>10</PageSize>\\n <Values>Doc</Values>\\n</ListTagValuesResponse>","errorExample":""}]', + 'title' => 'ListTagValues', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=ListTagValues\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'TagResources' => [ + 'summary' => '为资源列表创建并绑定标签', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92721', + 'abilityTreeNodes' => [ + 'FEATUREessXN6KX4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the resource. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Only scaling groups are supported. Set the value to scalinggroup.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'scalinggroup', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of resource N. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of resource N. Valid values of N: 1 to 50.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-2zej7nf7hea77k5a****', + ], + 'required' => true, + 'example' => 'asg-bp17xb4x1vr29lgt****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N. Valid values of N: 1 to 20.'."\n" + ."\n" + .'The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The value of tag N. Valid values of N: 1 to 20.'."\n" + ."\n" + .'The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'Propagate' => [ + 'description' => 'Specifies whether tag N can be propagated. Valid values:'."\n" + ."\n" + .'* true: Tag N can be propagated only to instances that are pending to be added to the scaling group.'."\n" + .'* false: Tag N cannot be propagated to an instance.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '74C4E313-8570-479F-8791-DC25360D****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74C4E313-8570-479F-8791-DC25360D****\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>74C4E313-8570-479F-8791-DC25360D****</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + 'description' => '## Description'."\n" + ."\n" + .'* You can add up to 20 tags to a scaling group.'."\n" + ."\n" + .'* Before you add tags to a scaling group, Auto Scaling automatically checks the number of existing tags of the scaling group. If the maximum number is exceeded, an error message is returned when you call the operation.'."\n" + ."\n" + .'* If you set the `Propagate` parameter to `true`, the tags that you add to a scaling group are propagated only to instances that are pending to be added to the scaling group. The tags are not propagated to instances that are already running in the scaling group.'."\n" + ."\n" + .'* If you add tags to a scaling group and set the Propagate parameter to true, the following rules apply:'."\n" + ."\n" + .' * The tags of instances that are pending to be added to the scaling group include the following tags: tags that are specified in the scaling configuration based on which the instances are created and tags that are added to the scaling group and propagated to the instances.'."\n" + .' * If the tags that are specified in the scaling configuration and the tags that are added to the scaling group and propagated to the instances have the same tag keys, the tags that are added to the scaling group and propagated to the instances are overwritten by the tags that are specified in the scaling configuration.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '为指定的弹性伸缩资源列表统一解绑标签', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92722', + 'abilityTreeNodes' => [ + 'FEATUREessXN6KX4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the resource. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Only scaling groups are supported. Set the value to scalinggroup.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'scalinggroup', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to unbind all tags from the resource. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:'."\n" + ."\n" + .'* true: All tags are unbound from the resource.'."\n" + .'* false: No tags are unbound.'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the Auto Scaling resources. You can specify 1 to 50 resource IDs.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The keys of the tags that you want to remove from the Auto Scaling resource. You can specify 1 to 20 tag keys.', + 'example' => 'asg-bp17xb4x1vr29lgt****', + ], + 'required' => true, + 'example' => 'asg-bp17xb4x1vr29lgt****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The keys of the tags that you want to remove from the Auto Scaling resource. You can specify 1 to 20 tag keys.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The ID of the request.', + 'example' => 'TestKey', + ], + 'required' => false, + 'example' => 'TestKey', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3AEBB1B9-5B13-4311-951F-C3C7FA2B73ED', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3AEBB1B9-5B13-4311-951F-C3C7FA2B****\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>3AEBB1B9-5B13-4311-951F-C3C7FA2B****</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=UntagResources\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAlarm' => [ + 'summary' => '创建一个报警任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92653', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestAlarmTask', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test alarm task.', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the metric. Valid values of MetricName vary based on the value of MetricType.'."\n" + ."\n" + .'* If you set MetricType to custom, the valid values of MetricName are your custom metrics.'."\n" + ."\n" + .'* If you set MetricType to system, MetricName has the following valid values:'."\n" + ."\n" + .' * CpuUtilization: (ECS) the CPU utilization. Unit: %.'."\n" + .' * IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.'."\n" + .' * IntranetRx: the inbound traffic over the internal network to an ECS instance. Unit: KB/min.'."\n" + .' * VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.'."\n" + .' * VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * SystemDiskReadBps: the number of bytes read from the system disk that is used by an ECS instance per second.'."\n" + .' * SystemDiskWriteBps: the number of bytes written to the system disk that is used by an ECS instance per second.'."\n" + .' * SystemDiskReadOps: the number of read operations on the system disk that is used by an ECS instance per second.'."\n" + .' * SystemDiskWriteOps: the number of write operations on the system disk that is used by an ECS instance per second.'."\n" + .' * CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.'."\n" + .' * GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.'."\n" + .' * GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.'."\n" + .' * MemoryUtilization: the memory usage of an agent. Unit: %.'."\n" + .' * LoadAverage: the average system load of an agent.'."\n" + .' * TcpConnection: the total number of TCP connections of an agent.'."\n" + .' * TcpConnection: the number of established TCP connections of an agent.'."\n" + .' * PackagesNetOut: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.'."\n" + .' * PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.'."\n" + .' * EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.'."\n" + .' * EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.'."\n" + ."\n" + .'For more information, see [Event-triggered task for system monitoring](~~74854~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUtilization', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the metric. Valid values:'."\n" + ."\n" + .'* system: system metrics of CloudMonitor'."\n" + .'* custom: custom metrics that are reported to CloudMonitor'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + 'default' => 'system', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The period of time during which statistics about the metric is collected. Unit: seconds. Valid values:'."\n" + ."\n" + .'* 15'."\n" + .'* 60'."\n" + .'* 120'."\n" + .'* 300'."\n" + .'* 900'."\n" + ."\n" + .'> If your scaling group is of the ECS type and uses CloudMonitor metrics, you can set Period to 15. In other cases, you can set Period to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that is used to aggregate statistics for the metric. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Minimum'."\n" + .'* Maximum'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + 'default' => 'Average', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The threshold of a metric in the multi-metric alert rule. If the threshold is reached the specified number of times within the specified period, a scaling rule is executed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '80.0', + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operator that is used to compare the metric value and the metric threshold. Valid values:'."\n" + ."\n" + .'* If the metric value is greater than or equal to the metric threshold, set the value to `>=`.'."\n" + .'* If the metric value is less than or equal to the metric threshold, set the value to `<=`.'."\n" + .'* If the metric value is greater than the metric threshold, set the value to `>`.'."\n" + .'* If the metric value is less than the metric threshold, set the value to `<`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '>=', + 'default' => '>=', + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of times that the threshold must be reached before a scaling rule can be executed. For example, if you set this parameter to 3, the average CPU utilization must reach or exceed 80% three times in a row before a scaling rule is triggered.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'default' => '3', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application group to which the custom metric belongs. This parameter must be specified when MetricType is set to custom.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4055401', + ], + ], + [ + 'name' => 'Effective', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective period of the event-triggered task.'."\n" + ."\n" + .'The Effective value follows the cron expression format. The default format is `X X X X X ?`. In the format:'."\n" + ."\n" + .'* X: a placeholder for a field, which represents seconds, minutes, hours, days, and months in sequence. X can be a definite value or a special character that has logical meaning. For information about the valid values of X, see [Cron expression](~~25907~~).'."\n" + .'* ?: No value is specified.'."\n" + ."\n" + .'> By default, the value of this parameter is specified in **UTC+8**. You can specify the time zone in the `TZ=+yy` format before a cron expression. y indicates the time zone. For example, `TZ=+00 * * 1-2 * * ?` specifies that the event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* ` * * * * * ? `: The event-triggered task is in effect at all times.'."\n" + .'* ` * * 17-18 * * ? `: The event-triggered task is in effect between 17:00:00 and 18:59:00 (UTC+8) every day.'."\n" + .'* `TZ=+00 * * 1-2 * * ?`: The event-triggered task is in effect between 01:00:00 and 02:59:00 (UTC+0) every day.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TZ=+00 * * 1-2 * * ?', + ], + ], + [ + 'name' => 'AlarmAction', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of unique identifiers of the scaling rules that are associated with the event-triggered task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of unique identifiers of the scaling rules that are associated with the event-triggered task.', + 'type' => 'string', + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn****', + ], + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn****', + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The quota dimension.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The quota dimension.'."\n", + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'description' => 'The key of the metric dimension. The valid values vary based on the metric type.'."\n" + ."\n" + .'If you set the MetricType parameter to custom, you can specify this parameter based on your business requirements.'."\n" + ."\n" + .'If you set the MetricType parameter to system, this parameter has the following valid values:'."\n" + ."\n" + .'- user_id: the ID of your Alibaba Cloud account'."\n" + .'- scaling_group: the scaling group that you want to monitor'."\n" + .'- device: the type of the NIC'."\n" + .'- state: the status of the TCP connection', + 'type' => 'string', + 'required' => false, + 'example' => 'device', + ], + 'DimensionValue' => [ + 'description' => 'The value of the metric dimension. The valid values vary based on the value of the DimensionKey parameter.'."\n" + ."\n" + .'- If you set the MetricType parameter to custom, you can specify this parameter based on your business requirements.'."\n" + ."\n" + .'- If you set the MetricType parameter to system, the following rules apply:'."\n" + ."\n" + .' - If you set the DimensionKey parameter to user_id, the system specifies the value of the DimensionValue parameter.'."\n" + ."\n" + .' - If you set the DimensionKey parameter to scaling_group, the system specifies the value of the DimensionValue parameter.'."\n" + ."\n" + .' - If you set the DimensionKey parameter to device, you can set the DimensionValue parameter to eth0 or eth1.'."\n" + ."\n" + .' - For instances that reside in the classic network, eth0 specifies the internal NIC. Only one eth0 NIC exists on each instance that resides in a VPC.'."\n" + .' - For instances that reside in the classic network, eth1 specifies the public NIC.'."\n" + .' - If you set the DimensionKey parameter to state, you can set the DimensionValue parameter to TCP_TOTAL or ESTABLISHED.'."\n" + ."\n" + .' - TCP_TOTAL specifies the total number of TCP connections.'."\n" + .' - ESTABLISHED specifies the number of established TCP connections.', + 'type' => 'string', + 'required' => false, + 'example' => 'eth0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Expression', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The expressions that are specified in the multi-metric alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The expressions that are specified in the multi-metric alert rule.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The name of the metric. Valid values of MetricName vary based on the value of MetricType.'."\n" + ."\n" + .'* If you set MetricType to custom, the valid values of MetricName are your custom metrics.'."\n" + ."\n" + .'* If you set MetricType to system, MetricName has the following valid values:'."\n" + ."\n" + .' * CpuUtilization: (ECS) the CPU utilization. Unit: %.'."\n" + .' * IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.'."\n" + .' * IntranetRx: the inbound traffic over the internal network to an ECS instance. Unit: KB/min.'."\n" + .' * VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.'."\n" + .' * VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * SystemDiskReadBps: the number of bytes read from the system disk that is used by an ECS instance per second.'."\n" + .' * SystemDiskWriteBps: the number of bytes written to the system disk that is used by an ECS instance per second.'."\n" + .' * SystemDiskReadOps: the number of read operations on the system disk that is used by an ECS instance per second.'."\n" + .' * SystemDiskWriteOps: the number of write operations on the system disk that is used by an ECS instance per second.'."\n" + .' * CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.'."\n" + .' * GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.'."\n" + .' * GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.'."\n" + .' * MemoryUtilization: the memory usage of an agent. Unit: %.'."\n" + .' * LoadAverage: the average system load of an agent.'."\n" + .' * TcpConnection: the total number of TCP connections of an agent.'."\n" + .' * TcpConnection: the number of established TCP connections of an agent.'."\n" + .' * PackagesNetOut: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.'."\n" + .' * PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.'."\n" + .' * EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.'."\n" + .' * EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.'."\n" + ."\n" + .'For more information, see [Event-triggered task for system monitoring](~~74854~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUtilization', + ], + 'ComparisonOperator' => [ + 'description' => 'The operator that is used to compare the metric value and the metric threshold. Valid values:'."\n" + ."\n" + .'* If the metric value is greater than or equal to the metric threshold, set the value to `>=`.'."\n" + .'* If the metric value is less than or equal to the metric threshold, set the value to `<=`.'."\n" + .'* If the metric value is greater than the metric threshold, set the value to `>`.'."\n" + .'* If the metric value is less than the metric threshold, set the value to `<`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '>=', + ], + 'Period' => [ + 'description' => 'The period of time during which statistics about the metric is collected. Unit: seconds. Valid values:'."\n" + ."\n" + .'* 15'."\n" + .'* 60'."\n" + .'* 120'."\n" + .'* 300'."\n" + .'* 900'."\n" + ."\n" + .'> If your scaling group is of the ECS type and uses CloudMonitor metrics, you can set Period to 15. In other cases, you can set Period to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '900', + ], + 'Statistics' => [ + 'description' => 'The method that is used to aggregate statistics for the metric. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Minimum'."\n" + .'* Maximum'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Threshold' => [ + 'description' => 'The thresholds of the metric values. If the thresholds are reached the specified number of times within the specified period, a scaling rule is executed.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '40.0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ExpressionsLogicOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The relationship between the trigger conditions in the multi-metric alert rule. Valid values:'."\n" + ."\n" + .'* `&&`: An alert is triggered only if all metrics in the multi-metric alert rule meet the trigger conditions. In this case, an alert is triggered only if the results of all trigger conditions that are specified in the multi-metric alert rule are `true`.'."\n" + .'* \\`\\`: An alert is triggered as long as one of the metrics in the multi-metric alert rule meets the trigger condition.'."\n" + ."\n" + .'Default value: `&&`'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '&&', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AlarmTaskId' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmTaskId\\": \\"asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlarmResponse>\\n <AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</CreateAlarmResponse>","errorExample":""}]', + 'title' => 'CreateAlarm', + 'description' => '## Description'."\n" + ."\n" + .'* If you set the **MetricType** parameter to **custom**, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using custom metrics. For more information, see [Custom monitoring event-triggered tasks](~~74861~~).'."\n" + ."\n" + .'* When you create an event-triggered task, you must specify the **MetricName**, **Dimension.N.DimensionKey**, and **Dimension.N.DimensionValue** parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the **user_id** and **scaling_group** dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances in a scaling group within an Alibaba Cloud account.'."\n" + ."\n" + .' * If you set the **MetricType** parameter to **custom**, the valid values are your custom metrics.'."\n" + .' * For information about the metrics that are supported if you set the **MetricType** parameter to **system**, see [Event-triggered task for system monitoring](~~74854~~).'."\n" + ."\n" + .'> The **user_id** and **scaling_group** dimensions are automatically populated. You need to only specify the **device** and **state** dimensions. For more information, see the `Dimension.N.DimensionKey` and `Dimension.N.DimensionValue` parameters in the "Request parameters" section of this topic.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteAlarm' => [ + 'summary' => '删除一个报警任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '92662', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'AlarmTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AlarmTaskId' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6EF9BFEE-FE07-4627-B8FB-14326FB9****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmTaskId\\": \\"asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****\\",\\n \\"RequestId\\": \\"6EF9BFEE-FE07-4627-B8FB-14326FB9****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlarmResponse>\\n <AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>\\n <RequestId>6EF9BFEE-FE07-4627-B8FB-14326FB9****</RequestId>\\n</DeleteAlarmResponse>","errorExample":""}]', + 'title' => 'DeleteAlarm', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DeleteAlarm\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableAlarm' => [ + 'summary' => '停用一个报警任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92693', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'AlarmTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '086EFCD4-C76F-4DC6-9EE9-0D9B711E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"086EFCD4-C76F-4DC6-9EE9-0D9B711E****\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAlarmResponse>\\n <RequestId>086EFCD4-C76F-4DC6-9EE9-0D9B711E****</RequestId>\\n</DisableAlarmResponse>","errorExample":""}]', + 'title' => 'DisableAlarm', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DisableAlarm\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableAlarm' => [ + 'summary' => '启用一个报警任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92695', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'AlarmTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '688B18B8-FB1E-42EB-A1ED-7F55B090****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"688B18B8-FB1E-42EB-A1ED-7F55B090****\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableAlarmResponse>\\n <RequestId>688B18B8-FB1E-42EB-A1ED-7F55B090****</RequestId>\\n</EnableAlarmResponse>","errorExample":""}]', + 'title' => 'EnableAlarm', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=EnableAlarm\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAlarm' => [ + 'summary' => '修改报警任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92703', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'AlarmTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alarmtask****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test alarm task.', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the metric. The valid values vary based on the metric type.'."\n" + ."\n" + .'* If you set **MetricType** to **custom**, the valid values are your custom metrics.'."\n" + ."\n" + .'* If you set **MetricType** to **system**, the **MetricName** parameter has the following valid values:'."\n" + ."\n" + .' * **CpuUtilization**: the CPU utilization of an ECS instance. Unit: %.'."\n" + .' * **IntranetTx**: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.'."\n" + .' * **IntranetRx**: the inbound traffic over the Internet to an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.'."\n" + .' * **VpcInternetTx**: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * **VpcInternetRx**: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * **SystemDiskReadBps**: the number of bytes read from the system disk used by an ECS instance per second.'."\n" + .' * **SystemDiskWriteBps**: the number of bytes written to the system disk used by an ECS instance per second.'."\n" + .' * **SystemDiskReadOps**: the number of read operations on the system disk used by an ECS instance per second.'."\n" + .' * **SystemDiskWriteOps**: the number of write operations on the system disk used by an ECS instance per second.'."\n" + .' * **CpuUtilizationAgent**: the CPU utilization of an agent. Unit: %.'."\n" + .' * **GpuUtilizationAgent**: the GPU utilization of an agent. Unit: %.'."\n" + .' * **GpuMemoryFreeUtilizationAgent**: the percentage of idle GPU memory of an agent.'."\n" + .' * **GpuMemoryUtilizationAgent**: the GPU memory usage of an agent. Unit: %.'."\n" + .' * **MemoryUtilization**: the memory usage of an agent. Unit: %.'."\n" + .' * **LoadAverage**: the average system load of an agent.'."\n" + .' * **TcpConnection**: the total number of TCP connections of an agent.'."\n" + .' * **TcpConnection**: the number of established TCP connections of an agent.'."\n" + .' * **PackagesNetOut**: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.'."\n" + .' * **PackagesNetIn**: the number of packets that are received by the internal NIC used by an agent.'."\n" + .' * **EciPodCpuUtilization**: the CPU utilization of an elastic container instance. Unit: %.'."\n" + .' * **EciPodMemoryUtilization**: the memory usage of an elastic container instance. Unit: %.'."\n" + ."\n" + .'For more information, see [Event-triggered task for system monitoring](~~74854~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MemoryUtilization', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the metric. Valid values:'."\n" + ."\n" + .'* system: system metrics of CloudMonitor'."\n" + .'* custom: custom metrics that are reported to CloudMonitor'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + 'default' => 'system', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The period during which the statistical value of the metric is collected. Unit: seconds. Valid values:'."\n" + ."\n" + .'* 15'."\n" + ."\n" + .'* 60'."\n" + ."\n" + .'* 120'."\n" + ."\n" + .'* 300'."\n" + ."\n" + .'* 900'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If your scaling group is of the ECS type and the event-triggered task associated with your scaling group monitors CloudMonitor metrics, you can set the **Period** parameter to **15**. Otherwise, you can set the **Period **parameter to **60**, **120**, **300**, or **900**. In most cases, the name of a CloudMonitor metric contains Agent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that is used to collect statistics about the metric. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Minimum'."\n" + .'* Maximum'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The threshold of the metric value. If the threshold is reached *N* times within the specified period, a scaling rule is executed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operator that is used to compare the metric value and the threshold.'."\n" + ."\n" + .'* If the metric value is greater than or equal to the threshold, set the value to `>=`.'."\n" + .'* If the metric value is less than or equal to the threshold, set the value to `<=`.'."\n" + .'* If the metric value is greater than the threshold, set the value to `>`.'."\n" + .'* If the metric value is less than the threshold, set the value to `<`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '>=', + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of times that the threshold must be reached before a scaling rule can be executed. For example, if you set this parameter to **3**, the average CPU utilization must reach or exceed 80% three times in a row before a scaling rule is triggered.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the application group to which the custom metric belongs. If you set the **MetricType** parameter to **custom**, you must specify this parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4055401', + ], + ], + [ + 'name' => 'Effective', + 'in' => 'query', + 'schema' => [ + 'description' => 'The effective period of the event-triggered task.'."\n" + ."\n" + .'This parameter follows the cron expression format. The default format is `X X X X X ?`, in which:'."\n" + ."\n" + .'* X: a placeholder for a field, which represents seconds, minutes, hours, days, and months in sequence. X can be a definite value or a special character that has logical meaning. For information about the valid values of X, see [Cron expression](~~25907~~).'."\n" + .'* ?: No value is specified.'."\n" + ."\n" + .'> **By default, the value of this parameter is specified in UTC+8**. You can specify the time zone before a cron expression in the `TZ=+yy` format. y indicates the time zone. For example, `TZ=+00 * * 1-2 * * ?` specifies that the event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.'."\n" + ."\n" + .'Sample values:'."\n" + ."\n" + .'* ` * * * * * ? `: The event-triggered task is in effect all the time.'."\n" + .'* ` * * 17-18 * * ? `: The event-triggered task is in effect between 17:00 and 18:59 (UTC+8) every day.'."\n" + .'* `TZ=+00 * * 1-2 * * ?`: The event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TZ=+00 * * 1-2 * * ?', + ], + ], + [ + 'name' => 'AlarmAction', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The unique identifiers of the scaling rules that are associated with the event-triggered task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The unique identifier of scaling rule *N* that is associated with the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp163l21e07uhn****', + ], + 'required' => false, + 'example' => 'ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp163l21e07uhn****', + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The dimensions of the metric.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'description' => 'The key of dimension *N* that is associated with the metric. The valid values vary based on the metric type.'."\n" + ."\n" + .'* If you set **MetricType** to **custom**, you can specify this parameter based on your business requirements.'."\n" + ."\n" + .'* If you set **MetricType** to **system**, this parameter has the following valid values:'."\n" + ."\n" + .' * **user_id**: the ID of your Alibaba Cloud account'."\n" + .' * **scaling_group**: the scaling group that you want to monitor'."\n" + .' * **device**: the type of the NIC'."\n" + .' * **state**: the status of the TCP connection'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'device', + ], + 'DimensionValue' => [ + 'description' => 'The value of dimension *N *that is associated with the metric. The valid values vary based on the value of **Dimension.N.DimensionKey**.'."\n" + ."\n" + .'* If you set **Dimension.N.DimensionKey** to a custom value, you can specify this parameter based on your business requirements.'."\n" + ."\n" + .'* If the value of **Dimension.N.DimensionKey** is specified by the system, this parameter has the following valid values:'."\n" + ."\n" + .' * **user_id**: The system specifies the value.'."\n" + ."\n" + .' * **scaling_group**: The system specifies the value.'."\n" + ."\n" + .' * **device**: You can set this parameter to **eth0 **or **eth1**.'."\n" + ."\n" + .' * For instances that reside in the classic network type, **eth0 **specifies the internal NIC. Only one eth0 NIC exists on each instance that resides in a VPC.'."\n" + .' * For instances that reside in the classic network, **eth1 **specifies the public NIC.'."\n" + ."\n" + .' * **state**: You can set this parameter to **TCP_TOTAL **or **ESTABLISHED**.'."\n" + ."\n" + .' * **TCP_TOTAL **specifies the total number of TCP connections.'."\n" + .' * **ESTABLISHED **specifies the number of established TCP connections.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eth0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Expression', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The expressions that are specified in the multi-metric alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The expression that is specified in the multi-metric alert rule.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The names of the metrics that are specified in the multi-metric alert rule. The valid values vary based on the metric type.'."\n" + ."\n" + .'* If you set **MetricType **to **custom**, the valid values are your custom metrics.'."\n" + ."\n" + .'* If you set **MetricType **to **system**, this parameter has the following valid values:'."\n" + ."\n" + .' * **CpuUtilization**: the CPU utilization of an ECS instance. Unit: %.'."\n" + .' * **IntranetTx**: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.'."\n" + .' * **IntranetRx**: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * **VpcInternetTx**: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * **VpcInternetRx**: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .' * **SystemDiskReadBps**: the number of bytes read from the system disk used by an ECS instance per second.'."\n" + .' * **SystemDiskWriteBps**: the number of bytes written to the system disk used by an ECS instance per second.'."\n" + .' * **SystemDiskReadOps**: the number of read operations on the system disk used by an ECS instance per second.'."\n" + .' * **SystemDiskWriteOps**: the number of write operations on the system disk used by an ECS instance per second.'."\n" + .' * **CpuUtilizationAgent**: the CPU utilization of an agent. Unit: %.'."\n" + .' * **GpuUtilizationAgent**: the GPU utilization of an agent. Unit: %.'."\n" + .' * **GpuMemoryFreeUtilizationAgent**: the percentage of idle GPU memory of an agent.'."\n" + .' * **GpuMemoryUtilizationAgent**: the GPU memory usage of an agent. Unit: %.'."\n" + .' * **MemoryUtilization**: the memory usage of an agent. Unit: %.'."\n" + .' * **LoadAverage**: the average system load of an agent.'."\n" + .' * **TcpConnection**: the total number of TCP connections of an agent.'."\n" + .' * **TcpConnection**: the number of established TCP connections of an agent.'."\n" + .' * **PackagesNetOut**: the number of packets that are sent by the internal NIC used by an agent.'."\n" + .' * **PackagesNetIn**: the number of packets that are received by the internal NIC used by an agent.'."\n" + .' * **EciPodCpuUtilization**: the CPU utilization of an elastic container instance. Unit: %.'."\n" + .' * **EciPodMemoryUtilization**: the memory usage of an elastic container instance. Unit: %.'."\n" + ."\n" + .'For more information, see [Event-triggered task for system monitoring](~~74854~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUtilization', + ], + 'ComparisonOperator' => [ + 'description' => 'The operator that is used to compare the metric value and the threshold.'."\n" + ."\n" + .'* If the metric value is greater than or equal to the threshold, set the value to **>=**.'."\n" + .'* If the metric value is less than or equal to the threshold, set the value to **<=**.'."\n" + .'* If the metric value is greater than the threshold, set the value to** >**.'."\n" + .'* If the metric value is less than the threshold, set the value to **<**.'."\n" + ."\n" + .'Default value: **>=**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '>=', + ], + 'Period' => [ + 'description' => 'The period during which the statistical values of the metrics that are specified in the multi-metric alert rule are collected. Unit: seconds.'."\n" + ."\n" + .'* 15'."\n" + ."\n" + .'* 60'."\n" + ."\n" + .'* 120'."\n" + ."\n" + .'* 300'."\n" + ."\n" + .'* 900'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If your scaling group is of the ECS type and the event-triggered task associated with your scaling group monitors CloudMonitor metrics, you can set the **Period** parameter to **15**. Otherwise, you can set the **Period** parameter to **60**, **120**, **300**, or **900**. In most cases, the name of a CloudMonitor metric contains Agent.'."\n" + ."\n" + .' Default value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + 'Statistics' => [ + 'description' => 'The method that is used to aggregate statistics about the metrics that are specified in the multi-metric alert rule. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Minimum'."\n" + .'* Maximum'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Threshold' => [ + 'description' => 'The thresholds of the metric values. If the thresholds are reached *N* times within the specified period, a scaling rule is executed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '40.0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ExpressionsLogicOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The relationship between the trigger conditions in the multi-metric alert rule. Valid values:'."\n" + ."\n" + .'* `&&`: An alert is triggered only if all metrics in the multi-metric alert rule meet the trigger conditions. In this case, an alert is triggered only if the results of all trigger conditions that are specified in the multi-metric alert rule are `true`.'."\n" + .'* `||`: An alert is triggered if one of the metrics in the multi-metric alert rule meets the trigger condition.'."\n" + ."\n" + .'Default value: `&&`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '&&', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AlarmTaskId' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1hvbnmkl10vll5****_83948190-acdd-483f-98f7-b77f4778****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BACACF83-7070-4953-A8FD-D81F89F1****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmTaskId\\": \\"asg-bp1hvbnmkl10vll5****\\",\\n \\"RequestId\\": \\"BACACF83-7070-4953-A8FD-D81F89F1****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAlarmResponse>\\n <AlarmTaskId>asg-bp1hvbnmkl10vll5****</AlarmTaskId>\\n <RequestId>BACACF83-7070-4953-A8FD-D81F89F1****</RequestId>\\n</ModifyAlarmResponse>","errorExample":""}]', + 'title' => 'ModifyAlarm', + 'description' => '## Description'."\n" + ."\n" + .'* If you set **MetricType** to **custom**, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using custom metrics. For more information, see [Custom monitoring event-triggered tasks](~~74861~~).'."\n" + ."\n" + .'* When you create an event-triggered task, you must specify the **MetricName**, **Dimension.N.DimensionKey**, and **Dimension.N.DimensionValue** parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the **user_id** and **scaling_group** dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.'."\n" + ."\n" + .' * If you set **MetricType** to **custom**, the valid values are your custom metrics.'."\n" + .' * For information about the metrics that are supported if you set the **MetricType** parameter to **system**, see[ Event-triggered task for system monitoring](~~74854~~).'."\n" + ."\n" + .'> The **user_id** and **scaling_group** dimensions are automatically populated. You need to only specify the **device** and **state** dimensions. For more information, see the `Dimension.N.DimensionKey` and `Dimension.N.DimensionValue` parameters in the "Request parameters" section of this topic.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAlarms' => [ + 'summary' => '查询报警任务的信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92670', + 'abilityTreeNodes' => [ + 'FEATUREessBFLAJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group that is monitored by the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'AlarmTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the event-triggered task. Valid values:'."\n" + ."\n" + .'* ALARM: The alert condition is met and an alert is triggered.'."\n" + .'* OK: The alert condition is not met.'."\n" + .'* INSUFFICIENT_DATA: Auto Scaling cannot determine whether the alert condition is met due to insufficient data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the event-triggered task feature. Valid values:'."\n" + ."\n" + .'* true: enables the event-triggered task feature.'."\n" + .'* false: disables the event-triggered task feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the metric that is used by the event-triggered task. Valid values:'."\n" + ."\n" + .'* system: system metrics of CloudMonitor'."\n" + .'* custom: custom metrics that are reported to CloudMonitor'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + 'default' => 'system', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the metric.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUtilization', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '871C7C53-34A4-45AA-8C14-4B72FA6A****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of event-triggered tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AlarmList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => 'The event-triggered tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AlarmTaskId' => [ + 'description' => 'The ID of the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****', + ], + 'MetricName' => [ + 'description' => 'The name of the metric. Valid values:'."\n" + ."\n" + .'* CpuUtilization: the CPU utilization of an Elastic Compute Service (ECS) instance. Unit: %.'."\n" + .'* IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.'."\n" + .'* IntranetRx: the inbound traffic over the internal network to an ECS instance. Unit: KB/min.'."\n" + .'* VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.'."\n" + .'* VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .'* SystemDiskReadBps: the number of bytes read from the system disk that is used by an ECS instance per second.'."\n" + .'* SystemDiskWriteBps: the number of bytes written to the system disk that is used by an ECS instance per second.'."\n" + .'* SystemDiskReadOps: the number of read operations on the system disk that is used by an ECS instance per second.'."\n" + .'* SystemDiskWriteOps: the number of write operations on the system disk that is used by an ECS instance per second.'."\n" + .'* CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.'."\n" + .'* GpuUtilizationAgent: the GPU utilization of an agent. Unit: %.'."\n" + .'* GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.'."\n" + .'* GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.'."\n" + .'* MemoryUtilization: the memory usage of an agent. Unit: %.'."\n" + .'* LoadAverage: the average system load of an agent.'."\n" + .'* TcpConnection: the total number of TCP connections of an agent.'."\n" + .'* TcpConnection: the number of established TCP connections of an agent.'."\n" + .'* PackagesNetOut: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.'."\n" + .'* PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.'."\n" + .'* EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.'."\n" + .'* EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.'."\n" + ."\n" + .'For more information, see [Event-triggered task for system monitoring](~~74854~~).'."\n", + 'type' => 'string', + 'example' => 'CpuUtilization', + ], + 'EvaluationCount' => [ + 'description' => 'The number of times that the threshold must be reached before a scaling rule is executed. For example, if you set this parameter to 3, the average CPU utilization must reach 80% three times in a row before a scaling rule is executed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'State' => [ + 'description' => 'The status of the event-triggered task. Valid values:'."\n" + ."\n" + .'* ALARM: The alert condition is met and an alert is triggered.'."\n" + .'* OK: The alert condition is not met.'."\n" + .'* INSUFFICIENT_DATA: Auto Scaling cannot determine whether the alert condition is met due to insufficient data.'."\n", + 'type' => 'string', + 'example' => 'ALARM', + ], + 'Period' => [ + 'description' => 'The statistical period of the metric data. Unit: seconds. Valid values:'."\n" + ."\n" + .'* 15'."\n" + .'* 60'."\n" + .'* 120'."\n" + .'* 300'."\n" + .'* 900'."\n" + ."\n" + .'> If your scaling group is of the ECS type and the event-triggered task that is associated with your scaling group monitors CloudMonitor metrics, you can set the Period parameter to 15. In most cases, the name of a CloudMonitor metric contains Agent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group that is monitored by the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + 'ComparisonOperator' => [ + 'description' => 'The operator that is used to compare the metric value and the threshold.'."\n" + ."\n" + .'* Valid value if the metric value is greater than or equal to the threshold: >='."\n" + .'* Valid value if the metric value is less than or equal to the threshold: <='."\n" + .'* Valid value if the metric value is greater than the threshold: >'."\n" + .'* Valid value if the metric value is less than the threshold: <'."\n", + 'type' => 'string', + 'example' => '>=', + ], + 'Effective' => [ + 'description' => 'The period during which the event-triggered task is in effect.'."\n", + 'type' => 'string', + 'example' => '* * * * * ?', + ], + 'Description' => [ + 'description' => 'The description of the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'Test alarm task.', + ], + 'MetricType' => [ + 'description' => 'The type of the metric that is used by the event-triggered task. Valid values:'."\n" + ."\n" + .'* system: system metrics of CloudMonitor'."\n" + .'* custom: custom metrics that are reported to CloudMonitor'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'Name' => [ + 'description' => 'The name of the event-triggered task.'."\n", + 'type' => 'string', + 'example' => 'TestAlarmTask', + ], + 'Threshold' => [ + 'description' => 'The threshold of the metric value. If the threshold is reached the specified times within the specified period, a scaling rule is executed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '80.0', + ], + 'Enable' => [ + 'description' => 'Indicates whether the event-triggered task feature is enabled. Valid values:'."\n" + ."\n" + .'* true: The event-triggered task feature is enabled.'."\n" + .'* false: The event-triggered task feature is disabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Statistics' => [ + 'description' => 'The method that is used to collect statistics about the metric. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Minimum'."\n" + .'* Maximum'."\n", + 'type' => 'string', + 'example' => 'Average', + ], + 'Dimensions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Dimension' => [ + 'description' => 'The metric dimensions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'description' => 'The dimension key of the metric. Valid values:'."\n" + ."\n" + .'* user_id: the ID of your Alibaba Cloud account.'."\n" + .'* scaling_group: the scaling group that is monitored by the event-triggered task.'."\n" + .'* device: the type of the NIC.'."\n" + .'* state: the status of the TCP connection.'."\n", + 'type' => 'string', + 'example' => 'device', + ], + 'DimensionValue' => [ + 'description' => 'The dimension value of the metric. The value of this parameter varies based on the value of the DimensionKey parameter.'."\n" + ."\n" + .'* `user_id`: The system specifies the value.'."\n" + ."\n" + .'* `scaling_group`: The system specifies the value.'."\n" + ."\n" + .'* Valid values for `device`:'."\n" + ."\n" + .' * eth0: For classic network instances, eth0 indicates the internal NIC. Only one eth0 NIC exists on each instance of the VPC type.'."\n" + .' * eth1: For classic network instances, eth1 indicates the Internet NIC.'."\n" + ."\n" + .'Valid values for `state`:'."\n" + ."\n" + .'* TCP_TOTAL: the total number of TCP connections.'."\n" + .'* ESTABLISHED: the number of TCP connections that are established.'."\n", + 'type' => 'string', + 'example' => 'eth0', + ], + ], + ], + ], + ], + ], + 'AlarmActions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmAction' => [ + 'description' => 'The list of unique identifiers of the scaling rules that are associated with the event-triggered task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of unique identifiers of the scaling rules that are associated with the event-triggered task.', + 'type' => 'string', + 'example' => 'ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****', + ], + ], + ], + ], + 'Expressions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Expression' => [ + 'description' => 'The alert conditions of the multi-metric alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The names of the metrics in the multi-metric alert rule. Valid values:'."\n" + ."\n" + .'* CpuUtilization: the CPU utilization of an ECS instance. Unit: %.'."\n" + .'* IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.'."\n" + .'* IntranetRx: the inbound traffic over the internal network to an ECS instance. Unit: KB/min.'."\n" + .'* VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .'* VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.'."\n" + .'* SystemDiskReadBps: the number of bytes read from the system disk that is used by an ECS instance per second.'."\n" + .'* SystemDiskWriteBps: the number of bytes written to the system disk that is used by an ECS instance per second.'."\n" + .'* SystemDiskReadOps: the number of read operations on the system disk that is used by an ECS instance per second.'."\n" + .'* SystemDiskWriteOps: the number of write operations on the system disk that is used by an ECS instance per second.'."\n" + .'* CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.'."\n" + .'* GpuUtilizationAgent: the GPU utilization of an agent. Unit: %.'."\n" + .'* GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.'."\n" + .'* GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.'."\n" + .'* MemoryUtilization: the memory usage of an agent. Unit: %.'."\n" + .'* LoadAverage: the average system load of an agent.'."\n" + .'* TcpConnection: the total number of TCP connections of an agent.'."\n" + .'* TcpConnection: the number of established TCP connections of an agent.'."\n" + .'* PackagesNetOut: the number of packets sent by the internal NIC that is used by an agent.'."\n" + .'* PackagesNetIn: the number of packets received by the internal NIC that is used by an agent.'."\n" + .'* EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.'."\n" + .'* EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.'."\n" + ."\n" + .'For more information, see [Event-triggered task for system monitoring](~~74854~~).'."\n", + 'type' => 'string', + 'example' => 'CpuUtilization', + ], + 'ComparisonOperator' => [ + 'description' => 'The operator that is used to compare the metric value and the threshold. Valid values:'."\n" + ."\n" + .'* Valid value if the metric value is greater than or equal to the threshold: >='."\n" + .'* Valid value if the metric value is less than or equal to the threshold: <='."\n" + .'* Valid value if the metric value is greater than the threshold: >'."\n" + .'* Valid value if the metric value is less than the threshold: <'."\n" + ."\n" + .'Default value: >=.'."\n", + 'type' => 'string', + 'example' => '>=', + ], + 'Period' => [ + 'description' => 'The period of time during which statistics about the metrics in the multi-metric alert rule is collected. Unit: seconds. Valid values:'."\n" + ."\n" + .'* 15'."\n" + .'* 60'."\n" + .'* 120'."\n" + .'* 300'."\n" + .'* 900'."\n" + ."\n" + .'> If your scaling group is of the ECS type and the event-triggered task that is associated with your scaling group monitors CloudMonitor metrics, you can set the Period parameter to 15. In most cases, the name of a CloudMonitor metric contains Agent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'Statistics' => [ + 'description' => 'The method that is used to collect statistics about the metrics that are specified in the multi-metric alert rule. Valid values:'."\n" + ."\n" + .'* Average'."\n" + .'* Minimum'."\n" + .'* Maximum'."\n", + 'type' => 'string', + 'example' => 'Average', + ], + 'Threshold' => [ + 'description' => 'The thresholds of the metric values in the multi-metric alert rule. If the thresholds are reached the specified number of times within the specified period, a scaling rule is executed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '40.0', + ], + ], + ], + ], + ], + ], + 'ExpressionsLogicOperator' => [ + 'description' => 'The relationship between the trigger conditions that are specified in the multi-metric alert rule. Valid values:'."\n" + ."\n" + .'- `&&`: An alert is triggered only if all metrics in the multi-metric alert rule meet the trigger conditions. In this case, an alert is triggered only if the results of all trigger conditions that are specified in the multi-metric alert rule are `true`.'."\n" + .'- `||`: An alert is triggered if one of the metrics in the multi-metric alert rule meets the trigger conditions.', + 'type' => 'string', + 'example' => '&&', + ], + 'HybridMonitorNamespace' => [ + 'type' => 'string', + ], + 'HybridMetrics' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HybridMetric' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'Statistic' => [ + 'type' => 'string', + ], + 'Dimensions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Dimension' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DimensionKey' => [ + 'type' => 'string', + ], + 'DimensionValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'PromQL' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"871C7C53-34A4-45AA-8C14-4B72FA6A****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"AlarmList\\": {\\n \\"Alarm\\": [\\n {\\n \\"AlarmTaskId\\": \\"asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****\\",\\n \\"MetricName\\": \\"CpuUtilization\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"ALARM\\",\\n \\"Period\\": 300,\\n \\"ScalingGroupId\\": \\"asg-bp18p2yfxow2dloq****\\",\\n \\"ComparisonOperator\\": \\">=\\",\\n \\"Effective\\": \\"* * * * * ?\\",\\n \\"Description\\": \\"Test alarm task.\\",\\n \\"MetricType\\": \\"system\\",\\n \\"Name\\": \\"TestAlarmTask\\",\\n \\"Threshold\\": 80,\\n \\"Enable\\": true,\\n \\"Statistics\\": \\"Average\\",\\n \\"Dimensions\\": {\\n \\"Dimension\\": [\\n {\\n \\"DimensionKey\\": \\"device\\",\\n \\"DimensionValue\\": \\"eth0\\"\\n }\\n ]\\n },\\n \\"AlarmActions\\": {\\n \\"AlarmAction\\": [\\n \\"ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****\\"\\n ]\\n },\\n \\"Expressions\\": {\\n \\"Expression\\": [\\n {\\n \\"MetricName\\": \\"CpuUtilization\\",\\n \\"ComparisonOperator\\": \\">=\\",\\n \\"Period\\": 900,\\n \\"Statistics\\": \\"Average\\",\\n \\"Threshold\\": 40\\n }\\n ]\\n },\\n \\"ExpressionsLogicOperator\\": \\"&&\\",\\n \\"HybridMonitorNamespace\\": \\"aliyun-test\\",\\n \\"HybridMetrics\\": {\\n \\"HybridMetric\\": [\\n {\\n \\"Id\\": \\"a\\",\\n \\"Expression\\": \\"(a+b)/2\\",\\n \\"MetricName\\": \\"AliyunSmq_NumberOfMessagesVisible\\",\\n \\"Statistic\\": \\"Average\\",\\n \\"Dimensions\\": {\\n \\"Dimension\\": [\\n {\\n \\"DimensionKey\\": \\"queue\\",\\n \\"DimensionValue\\": \\"testQueue\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"PromQL\\": \\"(avg(last_over_time(AliyunMnsnew_ActiveMessages{region=\'cn-hangzhou\',userId=\'123456****\',queue=\'testQueue\'}[900s])) by (userId))/(avg(last_over_time(AliyunEss_RunningInstanceCount{instanceId=\'asg-bp1****\'}[900s])) by (userId) != 0)\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlarmsResponse>\\n <PageSize>10</PageSize>\\n <RequestId>871C7C53-34A4-45AA-8C14-4B72FA6A****</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>2</TotalCount>\\n <AlarmList>\\n <AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>\\n <MetricName>CpuUtilization</MetricName>\\n <EvaluationCount>3</EvaluationCount>\\n <State>ALARM</State>\\n <Period>300</Period>\\n <ScalingGroupId>asg-bp18p2yfxow2dloq****</ScalingGroupId>\\n <ComparisonOperator>>=</ComparisonOperator>\\n <Effective>* * * * * ?</Effective>\\n <Description>Test alarm task.</Description>\\n <MetricType>system</MetricType>\\n <Name>TestAlarmTask</Name>\\n <Threshold>80</Threshold>\\n <Enable>true</Enable>\\n <Statistics>Average</Statistics>\\n <Dimensions>\\n <DimensionKey>device</DimensionKey>\\n <DimensionValue>eth0</DimensionValue>\\n </Dimensions>\\n <AlarmActions>ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****</AlarmActions>\\n <Expressions>\\n <MetricName>CpuUtilization</MetricName>\\n <ComparisonOperator>>=</ComparisonOperator>\\n <Period>900</Period>\\n <Statistics>Average</Statistics>\\n <Threshold>40</Threshold>\\n </Expressions>\\n <ExpressionsLogicOperator>&&</ExpressionsLogicOperator>\\n </AlarmList>\\n</DescribeAlarmsResponse>","errorExample":""}]', + 'title' => 'DescribeAlarms', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DescribeAlarms\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachAlbServerGroups' => [ + 'summary' => '添加一个或多个ALB服务器组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92647', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region to which the scaling group belongs, such as cn-hangzhou and cn-shanghai. For more information, see [Regions and zones](~~40654~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ForceAttach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to add the Elastic Compute Service (ECS) instances in the scaling group to the newly associated ALB server group.'."\n" + ."\n" + .'* true: adds the ECS instances and returns the `ScalingActivityId` value. You can view the ID of the scaling activity to determine whether the existing instances are added.'."\n" + .'* false: does not add the ECS instances.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AlbServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ALB server groups.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AlbServerGroupId' => [ + 'description' => 'The ID of the ALB server group.'."\n" + ."\n" + .'N indicates the serial number of the ALB server group. You can associate only a limited number of ALB server groups with a scaling group. To view the available quota or manually request a quota increase, go to the [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sgp-ddwb0y0g6y9bjm****', + ], + 'Weight' => [ + 'description' => 'The weight of the ECS instance as a backend server after the instance is added to the ALB server group. If you increase the weight of an ECS instance, the number of access requests that are forwarded to the ECS instance increases. If you set the weight to 0, no access requests are forwarded to the ECS instance. Valid values: 0 to 100.'."\n" + ."\n" + .'N indicates the serial number of the ALB server group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number used by the ECS instance after the instance is added to ALB server group N. Valid values: 1 to 65535.'."\n" + ."\n" + .'N indicates the serial number of the ALB server group.'."\n" + ."\n" + .'> If the N values are the same but the port numbers are different, the system associates multiple ports in the scaling group with ALB server group N.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity in which Auto Scaling associates the ALB server group with the scaling group and adds ECS instances in the scaling group to the ALB server group. This parameter is valid only when you set `ForceAttach` to `true`.'."\n", + 'type' => 'string', + 'example' => 'asa-2ze6wxj8vsohn6j9****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-2ze6wxj8vsohn6j9****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachAlbServerGroupsResponse>\\n <ScalingActivityId>asa-2ze6wxj8vsohn6j9****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</AttachAlbServerGroupsResponse>","errorExample":""}]', + 'title' => 'AttachAlbServerGroups', + 'description' => '## Description'."\n" + ."\n" + .'Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:'."\n" + ."\n" + .'* The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group that you want to associate must reside in the same VPC.'."\n" + .'* The ALB server group is in the Available state.'."\n" + .'* You can associate only a limited number of ALB server groups with a scaling group. To view the available quota or manually request a quota increase, go to the [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'CreateEciScalingConfiguration' => [ + 'summary' => '创建一个ECI类型伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92654', + 'abilityTreeNodes' => [ + 'FEATUREessWJGIW5', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group for which you want to create the scaling configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp14wlu85wrpchm0****', + ], + ], + [ + 'name' => 'ScalingConfigurationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n" + ."\n" + .'The name of the scaling configuration must be unique within a scaling group in a region. If you do not specify this parameter, the value of the ScalingConfigurationId parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'scalingconfig****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group with which you want to associate the elastic container instance. Elastic container instances that are associated with the same security group can access each other.'."\n" + ."\n" + .'If you do not specify a security group, the system uses the default security group in the region that you selected. Make sure that the inbound rules of the security group contain the protocols and port numbers of the containers that you want to expose. If you do not have a default security group in the region, the system creates a default security group and then adds the declared container protocols and port numbers to the inbound rules of the security group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'sg-uf66jeqopgqa9hdn****', + ], + ], + [ + 'name' => 'ContainerGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the elastic container instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'nginx-test', + ], + ], + [ + 'name' => 'RestartPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restart policy of the elastic container instance. Valid values:'."\n" + ."\n" + .'* Always: always restart the elastic container instance.'."\n" + .'* Never: never restart the elastic container instance.'."\n" + .'* OnFailure: restart the elastic container instance upon failures.'."\n" + ."\n" + .'Default value: Always.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Always', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of vCPUs that you want to allocate to the elastic container instance. Unit: cores.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The memory size that you want to allocate to the elastic container instance. Unit: GiB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2.0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-uf66jeqopgqa9hdn****', + ], + ], + [ + 'name' => 'DnsPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Domain Name System (DNS) policy. Valid values:'."\n" + ."\n" + .'* None: use the DNS that is specified for the DnsConfig field.'."\n" + .'* Default: use the DNS that is specified for the runtime environment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'ImageSnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the image cache snapshot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'imc-2zebxkiifuyzzlhl****', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role that you want to associate with the elastic container instance. You can use an instance RAM role to access elastic container instances and Elastic Compute Service (ECS) instances. For more information, see [Use an instance RAM role by calling API operations](~~61178~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RamTestRole', + ], + ], + [ + 'name' => 'TerminationGracePeriodSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The buffer period during which the program handles operations before the program is stopped. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'AutoMatchImageCache', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically match the image cache. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Ipv6AddressCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of IPv6 addresses.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ActiveDeadlineSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bidding policy of the elastic container instance. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is a regular pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SpotPriceLimit', + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the preemptible elastic container instance. The value can contain up to three decimal places.'."\n" + ."\n" + .'If you set the SpotStrategy parameter to SpotWithPriceLimit, you must specify the SpotPriceLimit parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.025', + ], + ], + [ + 'name' => 'AutoCreateEip', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically create an elastic IP address (EIP) and then bind the EIP to the elastic container instance.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EipBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bandwidth of the EIP. Default value: 5. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000000', + 'minimum' => '0', + 'example' => '5', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname of the elastic container instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IngressBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum inbound bandwidth. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1024000', + ], + ], + [ + 'name' => 'EgressBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum outbound bandwidth. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1024000', + ], + ], + [ + 'name' => 'CpuOptionsCore', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of physical CPU cores. You can specify this parameter only for specific instance types. For more information, see [Customize CPU options](~~197781~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'CpuOptionsThreadsPerCore', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of threads per core. You can specify this parameter only for specific instance types. A value of 1 indicates that Hyper-Threading is disabled. For more information, see [Customize CPU options](~~197781~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'EphemeralStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the temporary storage space. By default, an enhanced SSD (ESSD) of the PL1 level is used. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'LoadBalancerWeight', + 'in' => 'query', + 'schema' => [ + 'description' => 'The weight of the elastic container instance as a backend server of the associated Server Load Balancer (SLB) instance. Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags of the elastic container instance. The tags must be specified in the key-value pair format. You can specify up to 20 tags. When you specify tag keys and tag values, take note of the following items:'."\n" + ."\n" + .'- A tag key can be up to 64 characters in length. The key cannot start with acs: or aliyun and cannot contain `http://` or `https://`. You cannot specify an empty string as a tag key.'."\n" + .'- A tag value can be up to 128 characters in length. The value cannot start with acs: or aliyun and cannot contain `http://` or `https://`. You can specify an empty string as a tag value.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the elastic container instance. The tags must be specified in the key-value pair format. You can specify up to 20 tags. When you specify tag keys and tag values, take note of the following items:'."\n" + ."\n" + .'- A tag key can be up to 64 characters in length. The key cannot start with acs: or aliyun and cannot contain `http://` or `https://`. You cannot specify an empty string as a tag key.'."\n" + .'- A tag value can be up to 128 characters in length. The value cannot start with acs: or aliyun and cannot contain `http://` or `https://`. You can specify an empty string as a tag value.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N. Valid values of N: 1 to 20.'."\n" + ."\n" + .'You cannot specify an empty string as a tag key. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The key cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'version', + ], + 'Value' => [ + 'description' => 'The value of tag N. Valid values of N: 1 to 20.'."\n" + ."\n" + .'You can specify an empty string as a tag value. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The value cannot start with `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ImageRegistryCredential', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the image repository.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the image repository.', + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => 'The password that is used to access image repository N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yourpaasword', + ], + 'Server' => [ + 'description' => 'The address of image repository N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com', + ], + 'UserName' => [ + 'description' => 'The username that is used to access image repository N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yourusername', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 11, + ], + ], + [ + 'name' => 'Container', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The minimum number of consecutive successes before a failed probe is considered successful. Default value: 1. Set the value to 1.', + 'type' => 'array', + 'items' => [ + 'description' => 'The minimum number of consecutive successes before a failed probe is considered successful. Default value: 1. Set the value to 1.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReadinessProbe.TimeoutSeconds' => [ + 'description' => 'The timeout period of the health check. Unit: seconds. Default value: 1. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'ReadinessProbe.SuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes that must occur for the check to be considered successful. Default value: 1. Set the value to 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SecurityContext.Capability.Add' => [ + 'description' => 'The permissions that you want to grant to the processes in container N. Valid values: NET_ADMIN and NET_RAW.'."\n" + ."\n" + .'> To use NET_RAW, you must submit a ticket.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permissions that you want to grant to the processes in container N. Valid values: NET_ADMIN and NET_RAW.'."\n" + ."\n" + .'> To use NET_RAW, you must submit a ticket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NET_ADMIN', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ReadinessProbe.TcpSocket.Port' => [ + 'description' => 'The port detected by Transmission Control Protocol (TCP) sockets when you use TCP sockets to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8000', + ], + 'ReadinessProbe.HttpGet.Scheme' => [ + 'description' => 'The protocol type of HTTP GET requests when you use HTTP requests to perform health checks. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'LivenessProbe.PeriodSeconds' => [ + 'description' => 'The interval at which the container is checked. Unit: seconds. Default value: 10. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Port' => [ + 'description' => 'The port number of the container. Valid values: 1 to 65535.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The port number of the container. Valid values: 1 to 65535.'."\n", + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => 'The type of the protocol. Valid values:'."\n" + ."\n" + .'* TCP'."\n" + .'* UDP'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'Port' => [ + 'description' => 'The port number. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + 'EnvironmentVar' => [ + 'description' => 'Information about environment variables.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about environment variables.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the environment variable. The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (_). The name cannot start with a digit. Specify the name in the [0-9a-zA-Z] format.', + 'type' => 'string', + 'required' => false, + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => 'The name of the environment variable. The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (_). The name cannot start with a digit. Specify the name in the [0-9a-zA-Z] format.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/bin', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 301, + ], + 'LivenessProbe.TcpSocket.Port' => [ + 'description' => 'The port to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8000', + ], + 'Tty' => [ + 'description' => 'Specifies whether to enable interaction. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'If the value of the Command parameter is /bin/bash, you must set this parameter to true.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'WorkingDir' => [ + 'description' => 'The working directory of the container.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/', + ], + 'LivenessProbe.HttpGet.Scheme' => [ + 'description' => 'The protocol type of HTTP GET requests when you use HTTP requests to perform health checks. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'ReadinessProbe.HttpGet.Port' => [ + 'description' => 'The port to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8080', + ], + 'Arg' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'array', + 'items' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'Gpu' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ReadinessProbe.InitialDelaySeconds' => [ + 'description' => 'The time period after the container is started and before the probe is initiated. Unit: seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Stdin' => [ + 'description' => 'Specifies whether the container allocates buffer resources to standard input streams when the container is running. If you do not specify this parameter, an end-of-file (EOF) error may occur.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Memory' => [ + 'description' => 'The memory size of the container. Unit: GiB.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'Name' => [ + 'description' => 'The name of the container image.', + 'type' => 'string', + 'required' => false, + 'example' => 'nginx', + ], + 'Image' => [ + 'description' => 'The image of the container.', + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest', + ], + 'LivenessProbe.InitialDelaySeconds' => [ + 'description' => 'The time period after the container is started and before the probe is initiated. Unit: seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'VolumeMount' => [ + 'description' => 'Information about the volume mount of the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the volume mount of the container.', + 'type' => 'object', + 'properties' => [ + 'MountPropagation' => [ + 'description' => 'The mount propagation setting of the volume. Mount propagation allows volumes that are mounted on one container to be shared with other containers in the same pod, or even with other pods on the same node. Valid values:'."\n" + ."\n" + .'* None: This volume mount does not receive subsequent mounts that are mounted to this volume or subdirectories of this volume by the host.'."\n" + .'* HostToCotainer: This volume mount receives all subsequent mounts that are mounted to this volume or subdirectories of this volume.'."\n" + .'* Bidirectional: The volume mount behaves the same as the HostToCotainer mount. The volume mount receives all subsequent mounts that are mounted to this volume or subdirectories of this volume. In addition, all volume mounts created by the container are propagated back to the host and to all containers of all pods that use the same volume.'."\n" + ."\n" + .'Default value: None.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'None', + ], + 'MountPath' => [ + 'description' => 'The directory on which the container mounts the volume.'."\n" + ."\n" + .'>Data in this directory is overwritten by the data on the volume.', + 'type' => 'string', + 'required' => false, + 'example' => '/pod/data', + ], + 'ReadOnly' => [ + 'description' => 'Specifies whether the volume is read-only. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Name' => [ + 'description' => 'The name of the volume. The value of this parameter is the same as the value of the VolumeName parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'default-volume1', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'data2/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + 'LivenessProbe.FailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures for the probe to be considered failed after having been successful.'."\n" + ."\n" + .'Default value: 3.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ReadinessProbe.Exec.Command' => [ + 'description' => 'The commands executed in the container when using the command line to perform the health check.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command.', + 'type' => 'string', + 'required' => false, + 'example' => 'cat /tmp/healthy', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'ReadinessProbe.FailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures for the probe to be considered failed after having been successful. Default value: 3.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ImagePullPolicy' => [ + 'description' => 'The policy that you want to use to pull an image. Valid values:'."\n" + ."\n" + .'* Always: Each time instances are created, image pulling is performed.'."\n" + .'* IfNotPresent: Image pulling is performed as needed. On-premises images are preferentially used. If no on-premises images are available, image pulling is performed.'."\n" + .'* Never: On-premises images are always used. Image pulling is not performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Always', + ], + 'StdinOnce' => [ + 'description' => 'Specifies whether to disconnect standard input streams after a client is disconnected.'."\n" + ."\n" + .'If you set the StdinOnce parameter to true, standard input streams are connected after the container is started, and remain idle until a client is connected to receive data. After the client is disconnected, streams are also disconnected, and remain disconnected until the container is started again.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores in the container.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'LivenessProbe.HttpGet.Port' => [ + 'description' => 'The port to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8888', + ], + 'LivenessProbe.HttpGet.Path' => [ + 'description' => 'The path to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'string', + 'required' => false, + 'example' => '/healthyz', + ], + 'LivenessProbe.SuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes for the probe to be considered successful after having failed. Default value: 1. Set the value to 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ReadinessProbe.PeriodSeconds' => [ + 'description' => 'The interval at which probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'LivenessProbe.TimeoutSeconds' => [ + 'description' => 'The timeout period for the probe. Unit: seconds. Default value: 1. Minimum value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Command' => [ + 'description' => 'The commands that you want to run in the container when you use the CLI to perform probes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command.', + 'type' => 'string', + 'required' => false, + 'example' => 'sleep', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'SecurityContext.RunAsUser' => [ + 'description' => 'The ID of the user that runs the container.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'ReadinessProbe.HttpGet.Path' => [ + 'description' => 'The path to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'string', + 'required' => false, + 'example' => '/healthz', + ], + 'LivenessProbe.Exec.Command' => [ + 'description' => 'The commands executed in the container when using the command line to perform the health check.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command.', + 'type' => 'string', + 'required' => false, + 'example' => 'cat/tmp/healthy', + ], + 'required' => false, + 'maxItems' => 21, + ], + 'LifecyclePostStartHandlerHttpGetHost' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerHttpGetPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePostStartHandlerHttpGetPath' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerHttpGetScheme' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerExec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + 'LifecyclePostStartHandlerTcpSocketHost' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerTcpSocketPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePreStopHandlerHttpGetHost' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerHttpGetPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePreStopHandlerHttpGetPath' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerHttpGetScheme' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerExec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + 'LifecyclePreStopHandlerTcpSocketHost' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerTcpSocketPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the volumes.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the volumes.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the Host file or path. Examples: File, Directory, and Socket.', + 'type' => 'string', + 'required' => false, + 'example' => 'ConfigFileVolume', + ], + 'DiskVolume.DiskSize' => [ + 'description' => 'The storage size of the disk volume. Unit: GiB.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + 'NFSVolume.Path' => [ + 'description' => 'The path of the NFS volume.', + 'type' => 'string', + 'required' => false, + 'example' => '/share', + ], + 'FlexVolume.FsType' => [ + 'description' => 'The type of the mounted file system. By default, the value of this parameter varies based on the script of FlexVolume.', + 'type' => 'string', + 'required' => false, + 'example' => 'ext4', + ], + 'DiskVolume.FsType' => [ + 'description' => 'The type of the disk volume. We recommend that you specify the `FlexVolume.FsType` parameter instead of the DiskVolume.FsType parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'xfs', + ], + 'HostPathVolume.Type' => [ + 'description' => 'The type of host directory. For example: File, Directory, Socket, etc.', + 'type' => 'string', + 'required' => false, + 'example' => 'Directory', + ], + 'NFSVolume.ReadOnly' => [ + 'description' => 'Specifies whether the NFS volume is read-only. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'HostPathVolume.Path' => [ + 'description' => 'The absolute path to the Host node.', + 'type' => 'string', + 'required' => false, + 'example' => '/xx/xx/path', + ], + 'FlexVolume.Options' => [ + 'description' => 'The FlexVolume objects. Each object is a key-value pair contained in a JSON string.'."\n" + ."\n" + .'If you set the Type parameter to FlexVolume, specify objects in the `{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}` format.', + 'type' => 'string', + 'required' => false, + 'example' => '{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}', + ], + 'FlexVolume.Driver' => [ + 'description' => 'The name of the FlexVolume driver.', + 'type' => 'string', + 'required' => false, + 'example' => 'flexvolume', + ], + 'ConfigFileVolumeDefaultMode' => [ + 'description' => 'The default permissions on the ConfigFile volume.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0644', + ], + 'NFSVolume.Server' => [ + 'description' => 'The endpoint of the NFS server.', + 'type' => 'string', + 'required' => false, + 'example' => '3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com', + ], + 'DiskVolume.DiskId' => [ + 'description' => 'The endpoint of the NFS server.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-xx', + ], + 'Name' => [ + 'description' => 'The name of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'default-volume1', + ], + 'EmptyDirVolume.Medium' => [ + 'description' => 'The storage medium when you set the Type parameter to EmptyDirVolume. If you leave this parameter empty, the file system that backs the node is used as the storage medium. If you set this parameter to memory, the memory is used as the storage medium.', + 'type' => 'string', + 'required' => false, + 'example' => 'memory', + ], + 'ConfigFileVolumeConfigFileToPath' => [ + 'description' => 'The paths to the configuration files.', + 'type' => 'array', + 'items' => [ + 'description' => 'The paths to the configuration files.', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The name of the environment variable. The name must be 1 to 128 characters in length. Specify the name in the `[0-9a-zA-Z]` format. The name can contain underscores and cannot start with a digit.', + 'type' => 'string', + 'required' => false, + 'example' => 'PATH', + ], + 'Mode' => [ + 'description' => 'The permissions on ConfigFileVolume.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0644', + ], + 'Content' => [ + 'description' => 'The content of the configuration file, which can be up to 32 KB in size.', + 'type' => 'string', + 'required' => false, + 'example' => 'bGl1bWk=', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 90, + ], + 'EmptyDirVolume.SizeLimit' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + ], + [ + 'name' => 'InitContainer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The init containers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The init containers.'."\n", + 'type' => 'object', + 'properties' => [ + 'InitContainerEnvironmentVar' => [ + 'description' => 'The environment variables of the init container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The environment variables of the init container.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the environment variable. Specify the key in the `[0-9a-zA-Z]` format. The key must be 1 to 128 characters in length. The key can contain underscores (_) and cannot start with a digit.', + 'type' => 'string', + 'required' => false, + 'example' => 'Path', + ], + 'Value' => [ + 'description' => 'The value of the environment variable. The value must be 0 to 256 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/bin/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 301, + ], + 'SecurityContext.Capability.Add' => [ + 'description' => 'The permissions granted to processes in the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permission granted to processes in the container. Valid values: NET_ADMIN and NET_RAW.'."\n" + ."\n" + .'>To use NET_RAW, you must submit a ticket.', + 'type' => 'string', + 'required' => false, + 'example' => 'NET_ADMIN', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'Image' => [ + 'description' => 'The container image.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nginx', + ], + 'InitContainerVolumeMount' => [ + 'description' => 'Information about the volume mounts of the init container.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the volume mounts of the init container.', + 'type' => 'object', + 'properties' => [ + 'MountPropagation' => [ + 'description' => 'The mount propagation settings of the volume . Mount propagation allows volumes that are mounted on one container to be shared with other containers in the same pod, or even with other pods on the same node. Valid values:'."\n" + ."\n" + .'- None: The volume mount does not receive subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'- HostToCotainer: The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'- Bidirectional: This value is similar to HostToCotainer. The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories. In addition, all volume mounts that are created by the container are propagated back to the instance and to all containers of all pods that use the same volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + ], + 'MountPath' => [ + 'description' => 'The path to which the volume is mounted. Data under this path is overwritten by the data on the volume.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/share/', + ], + 'ReadOnly' => [ + 'description' => 'Specifies whether the mount path is read-only.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Name' => [ + 'description' => 'The name of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-empty', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume. The elastic container instance can mount different directories of the same volume to different subdirectories of containers.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/sub/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + 'ImagePullPolicy' => [ + 'description' => 'The image pulling policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Always', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs that you want to allocate to the container.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'WorkingDir' => [ + 'description' => 'The working directory.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local', + ], + 'Command' => [ + 'description' => 'The list of commands that you want to run to start the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command.', + 'type' => 'string', + 'required' => false, + 'example' => 'sleep', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'Arg' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'array', + 'items' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'SecurityContext.RunAsUser' => [ + 'description' => 'The ID of the user that runs the container.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '587', + ], + 'Gpu' => [ + 'description' => 'The number of GPUs that you want to allocate to the container.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The size of the memory. Unit: GiB.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + 'Name' => [ + 'description' => 'The name of the container.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-init', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DnsConfigNameServer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IP addresses of the DNS servers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP addresses of the DNS servers.', + 'type' => 'string', + 'required' => false, + 'example' => '172.10.*.**', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'DnsConfigSearch', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The DNS lookup domains.', + 'type' => 'array', + 'items' => [ + 'description' => 'The DNS lookup domains.', + 'type' => 'string', + 'required' => false, + 'example' => 'svc.local.kubenetes', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'DnsConfigOption', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The options. Each option is in the name-value pair format. The value in the name-value pair is optional.', + 'type' => 'array', + 'items' => [ + 'description' => 'The options. Each option is in the name-value pair format. The value in the name-value pair is optional.', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The variable value of the option.', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + 'Name' => [ + 'description' => 'The variable value of the option.', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'HostAliase', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The hostnames and IP addresses of a container that you want to add to the hosts file of the elastic container instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hostnames and IP addresses of a container that you want to add to the hosts file of the elastic container instance.', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address that you want to add.', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + 'Hostname' => [ + 'description' => 'The hostname that you want to add.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname that you want to add.', + 'type' => 'string', + 'required' => false, + 'example' => 'hehe.com', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + ], + [ + 'name' => 'SecurityContextSysctl', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The system information of the security context in which the elastic container instance runs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The system information of the security context in which the elastic container instance runs.', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The variable value of the security context in which the elastic container instance runs.', + 'type' => 'string', + 'required' => false, + 'example' => '65536', + ], + 'Name' => [ + 'description' => 'The variable value of the security context in which the elastic container instance runs.', + 'type' => 'string', + 'required' => false, + 'example' => 'kernel.msgmax', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 11, + ], + ], + [ + 'name' => 'NtpServer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The domain name of the Network Time Protocol (NTP) server.', + 'type' => 'array', + 'items' => [ + 'description' => 'The domain name of the NTP server.', + 'type' => 'string', + 'required' => false, + 'example' => 'ntp.cloud.aliyuncs.com', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AcrRegistryInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the Container Registry Enterprise Edition instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the Container Registry Enterprise Edition instance.', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => 'The domain names of the Container Registry Enterprise Edition instances. By default, all domain names of the Container Registry Enterprise Edition instances are displayed. You can specify one or more domain names. Separate multiple domain names with commas (,).', + 'type' => 'array', + 'items' => [ + 'description' => 'The domain names of the Container Registry Enterprise Edition instances. By default, all domain names of the Container Registry Enterprise Edition instances are displayed. You can specify one or more domain names. Separate multiple domain names with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => '*****-****-registry.cn-beijing.cr.aliyuncs.com', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'InstanceName' => [ + 'description' => 'The name of the Container Registry Enterprise Edition instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'acr-test', + ], + 'InstanceId' => [ + 'description' => 'The ID of the Container Registry Enterprise Edition instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-nwj395hgf6f3****', + ], + 'RegionId' => [ + 'description' => 'The region ID of the Container Registry Enterprise Edition instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'CostOptimization', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Specifies whether to enable the cost optimization feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceFamilyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the instance type, which is used to filter the instance types that meet the specified criteria. This parameter takes effect only if you set the `CostOptimization` parameter to true. Valid values:'."\n" + ."\n" + .'* EntryLevel: shared instance type. Instances of this level are the most cost-effective but may not provide stable computing performance in a consistent manner. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see [Shared instance families](~~108489~~).'."\n" + .'* EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see [Instance family](~~25378~~).'."\n" + .'* CreditEntryLevel: This value is valid only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see the [Overview](~~59977~~) topic of burstable instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EnterpriseLevel', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 10, + ], + ], + [ + 'name' => 'DataCacheBucket', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DataCachePL', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DataCacheProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'DataCacheBurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'GpuDriverVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingConfigurationId' => [ + 'description' => 'The ID of the elastic container instance.'."\n", + 'type' => 'string', + 'example' => 'eci-uf6fonnghi50u374****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '89945DD3-9072-47D0-A318-353284CF****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Forbidden.RiskControl', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingConfigurationId\\": \\"asc-uf6fonnghi50u374****\\",\\n \\"RequestId\\": \\"89945DD3-9072-47D0-A318-353284CF****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateEciScalingConfigurationResponse>\\n <ScalingConfigurationId>eci-uf6fonnghi50u374****</ScalingConfigurationId>\\n <RequestId>89945DD3-9072-47D0-A318-353284CF****</RequestId>\\n</CreateEciScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'CreateEciScalingConfiguration', + 'description' => '## Description'."\n" + ."\n" + .'A scaling configuration is a template that is used to create elastic container instances during scale-out activities.'."\n" + ."\n" + .'You can specify the Cpu and Memory parameters to determine the range of instance types. Then, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances of the instance type that has the lowest price. This method is available only if the Scaling Policy parameter is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.'."\n", + ], + 'DeleteEciScalingConfiguration' => [ + 'summary' => '删除一个ECI类型伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92663', + 'abilityTreeNodes' => [ + 'FEATUREessTZHE2G', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asc-bp1bx8mzur534edp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request. This request ID is returned regardless of whether the request is successful.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'auditing', + 'type' => 'string', + 'example' => '45D5B0AD-3B00-4A9B-9911-6D5303B06712', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Forbidden.RiskControl', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"45D5B0AD-3B00-4A9B-9911-6D5303B0****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEciScalingConfigurationResponse>\\n <RequestId>45D5B0AD-3B00-4A9B-9911-6D5303B0****</RequestId>\\n</DeleteEciScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'DeleteEciScalingConfiguration', + ], + 'DescribeEciScalingConfigurations' => [ + 'summary' => '查询ECI类型伸缩组的伸缩配置信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92673', + 'abilityTreeNodes' => [ + 'FEATUREessU7F1S4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group to which the scaling configurations that you want to query belong.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '50', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group. You can query all scaling configurations in the scaling group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asg-bp17pelvl720x3v7****', + ], + ], + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the scaling configurations that you want to query.'."\n" + ."\n" + .'The IDs of active and inactive scaling configurations are displayed in the query results. You can differentiate between active and inactive scaling configurations based on the value of the LifecycleState parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of scaling configuration N that you want to query. Valid values of N: 1 to 10.'."\n" + ."\n" + .'The IDs of active and inactive scaling configurations are displayed in the query results. You can differentiate between active and inactive scaling configurations based on the value of the LifecycleState parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc-bp17pelvl720x5ub****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ScalingConfigurationName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The name of scaling configuration N that you want to query. Valid values of N: 1 to 10.'."\n" + ."\n" + .'The names of inactive scaling configurations are not displayed in the query results, and no error is reported.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of scaling configuration N that you want to query. Valid values of N: 1 to 10.'."\n" + ."\n" + .'The names of inactive scaling configurations are not displayed in the query results, and no error is reported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalingcon****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'TotalCount' => [ + 'description' => 'The total number of scaling configurations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScalingConfigurations' => [ + 'description' => 'Details of the scaling configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the scaling configuration was created.'."\n", + 'type' => 'string', + 'example' => '2014-08-14T10:58Z', + ], + 'ScalingConfigurationName' => [ + 'description' => 'The name of the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'scalingconfi****', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group with which the elastic container instance is associated. Elastic container instances that are associated with the same security group can access each other.'."\n", + 'type' => 'string', + 'example' => 'sg-bp18kz60mefs****', + ], + 'ActiveDeadlineSeconds' => [ + 'description' => 'The validity period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding policy for the elastic container instance. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'AutoCreateEip' => [ + 'description' => 'Indicates whether an elastic IP address (EIP) is automatically created, and then bound to the elastic container instance.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ScalingGroupId' => [ + 'description' => 'The ID of the scaling group in which the scaling configuration is created.'."\n", + 'type' => 'string', + 'example' => 'asg-bp17pelvl720x3v7****', + ], + 'EphemeralStorage' => [ + 'description' => 'The size of the temporary storage space. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Ipv6AddressCount' => [ + 'description' => 'The number of IPv6 addresses.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EipBandwidth' => [ + 'description' => 'The bandwidth of the EIP. Default value: 5. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ImageSnapshotId' => [ + 'description' => 'The ID of the image cache.'."\n", + 'type' => 'string', + 'example' => 'imc-2zebxkiifuyzzlhl****', + ], + 'Memory' => [ + 'description' => 'The size of the memory.'."\n" + ."\n" + .'You can specify the number of vCPUs and the memory size to specify the range of instance types. For example, you can set the **Cpu **parameter to 2 and the **Memory **parameter to 16 to specify the instance types that have 2 vCPUs and 16 GiB of memory. If you specify the **Cpu **and **Memory **parameters, Auto Scaling determines available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.'."\n" + ."\n" + .'> You can specify CPU and memory specifications to create instances only if the **Scaling Policy** parameter is set to **Cost Optimization Policy** and no instance type is specified in the scaling configuration.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '16', + ], + 'RestartPolicy' => [ + 'description' => 'The restart policy of the elastic container instance. Valid values:'."\n" + ."\n" + .'* Never: never restarts the elastic container instance.'."\n" + .'* Always: always restarts the elastic container instance.'."\n" + .'* OnFailure: restarts the elastic container instance upon failures.'."\n", + 'type' => 'string', + 'example' => 'Never', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price for the preemptible elastic container instance.'."\n" + ."\n" + .'This parameter is returned only if you set the **SpotStrategy** parameter to **SpotWithPriceLimit**.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.025', + ], + 'IngressBandwidth' => [ + 'description' => 'The maximum inbound bandwidth. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024000', + ], + 'CpuOptionsThreadsPerCore' => [ + 'description' => 'The number of threads per core. This parameter can be specified for only specific instance types. A value of 1 indicates that Hyper-Threading is disabled. For more information, see [Customize CPU options](~~197781~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TerminationGracePeriodSeconds' => [ + 'description' => 'The buffer time during which the program handles operations before the program stops.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'LoadBalancerWeight' => [ + 'description' => 'The weight of the elastic container instance as a backend server of the associated Server Load Balancer (SLB) instance. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DnsPolicy' => [ + 'description' => 'The Domain Name System (DNS) policy.'."\n", + 'type' => 'string', + 'example' => 'Default', + ], + 'HostName' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => '[\'hehe.com\', \'haha.com\']', + ], + 'EgressBandwidth' => [ + 'description' => 'The maximum outbound bandwidth. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024000', + ], + 'RegionId' => [ + 'description' => 'The region ID of the elastic container instance.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RamRoleName' => [ + 'description' => 'The name of the instance RAM role. You can use an instance RAM role to access both elastic container instances and Elastic Compute Service (ECS) instances. For more information, see [Use the instance RAM role by calling APIs](~~61178~~).'."\n", + 'type' => 'string', + 'example' => 'ram:PassRole', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs that are allocated to the elastic container instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2.0', + ], + 'AutoMatchImageCache' => [ + 'description' => 'Indicates whether the image cache is automatically matched.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-8db03793gfrz****', + ], + 'ContainerGroupName' => [ + 'description' => 'The name of the elastic container instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ScalingConfigurationId' => [ + 'description' => 'The ID of the scaling configuration.'."\n", + 'type' => 'string', + 'example' => 'asc-bp1ezrfgoyn5kijl****', + ], + 'CpuOptionsCore' => [ + 'description' => 'The number of physical CPU cores. This parameter can be specified for only specific instance types. For more information, see [Customize CPU options](~~197781~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Containers' => [ + 'description' => 'The containers in the elastic container instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReadinessProbeHttpGetPath' => [ + 'description' => 'The path to which HTTP GET requests were sent.'."\n", + 'type' => 'string', + 'example' => '/usr/local', + ], + 'ReadinessProbeSuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes for a probe to be considered successful after having failed. Default value: 1. Valid value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LivenessProbePeriodSeconds' => [ + 'description' => 'The interval at which probes are performed. Default value: 10. Minimum value: 1. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LivenessProbeTcpSocketPort' => [ + 'description' => 'The port number of TcpSocket.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'LivenessProbeHttpGetScheme' => [ + 'description' => 'The protocol type of HTTP GET requests when you use the HTTP GET requests to perform probes. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'WorkingDir' => [ + 'description' => 'The working directory of the container.'."\n", + 'type' => 'string', + 'example' => '/usr/local/nginx', + ], + 'Tty' => [ + 'description' => 'Indicates whether interaction is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'If the value of the **Command **parameter is **/bin/bash**, the value of this parameter must be set to true.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'LivenessProbeHttpGetPort' => [ + 'description' => 'The port to which HTTP GET requests were sent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Gpu' => [ + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReadinessProbeInitialDelaySeconds' => [ + 'description' => 'The number of seconds between the time when the startup of the container ends and the time when the probe starts.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Stdin' => [ + 'description' => 'Indicates whether the container allocates buffer resources to standard input streams when the container runs. If this parameter is not specified, an end-of-file (EOF) error may occur.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Memory' => [ + 'description' => 'The memory size of the container.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2.0', + ], + 'Name' => [ + 'description' => 'The name of the container.'."\n", + 'type' => 'string', + 'example' => 'nginx', + ], + 'LivenessProbeHttpGetPath' => [ + 'description' => 'The path to which HTTP GET requests were sent.'."\n", + 'type' => 'string', + 'example' => '/usr/nginx/', + ], + 'Image' => [ + 'description' => 'The image of the container.'."\n", + 'type' => 'string', + 'example' => 'mysql', + ], + 'ReadinessProbeTcpSocketPort' => [ + 'description' => 'The port number of TcpSocket.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8888', + ], + 'ReadinessProbeHttpGetScheme' => [ + 'description' => 'The protocol type of HTTP GET requests when you use the HTTP GET requests to perform probes. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + 'ReadinessProbeHttpGetPort' => [ + 'description' => 'The path to which HTTP GET requests were sent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '/usr/nginx/', + ], + 'LivenessProbeSuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes for a probe to be considered successful after having failed. Default value: 1. Valid value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReadinessProbeTimeoutSeconds' => [ + 'description' => 'The timeout period of a probe. Default value: 1. Minimum value: 1. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SecurityContextRunAsUser' => [ + 'description' => 'The ID of the user that runs the entry point of the container process.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'LivenessProbeInitialDelaySeconds' => [ + 'description' => 'The number of seconds between the time when the startup of the container ends and the time when the probe starts.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ReadinessProbePeriodSeconds' => [ + 'description' => 'The interval at which probes are performed. Default value: 10. Minimum value: 1. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ImagePullPolicy' => [ + 'description' => 'The image pulling policy. Valid values:'."\n" + ."\n" + .'* Always: Image pulling is performed each time.'."\n" + .'* IfNotPresent: Image pulling is performed only if on-premises images are unavailable. On-premises images are preferentially used. If no on-premises images are available, image pulling is performed.'."\n" + .'* Never: On-premises images are always used. Image pulling is not performed.'."\n", + 'type' => 'string', + 'example' => 'Always', + ], + 'StdinOnce' => [ + 'description' => 'Indicates whether standard input streams are disconnected after a client is disconnected. If Stdin is set to true, standard input streams remain connected during multiple sessions.'."\n" + ."\n" + .'When StdinOnce is set to true, standard input streams are connected after the container is started and remain idle until a client is connected to receive data. After the client is disconnected, streams are also disconnected and remain in the disconnected state until the container is started again.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs that are allocated to the container.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2.0', + ], + 'LivenessProbeTimeoutSeconds' => [ + 'description' => 'The timeout period of a probe. Default value: 1. Minimum value: 1. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ReadinessProbeFailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures for a probe to be considered failed after having been successful.'."\n" + ."\n" + .'Default value: 3.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'LivenessProbeFailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures for a probe to be considered failed after having been successful.'."\n" + ."\n" + .'Default value: 3.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Ports' => [ + 'description' => 'The exposed ports and protocols of the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => 'The port number. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8888', + ], + 'Protocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* TCP'."\n" + .'* UDP'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + ], + ], + ], + 'VolumeMounts' => [ + 'description' => 'The volumes that are mounted to the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReadOnly' => [ + 'description' => 'Indicates whether the volume is read-only.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume.'."\n", + 'type' => 'string', + 'example' => 'data2/', + ], + 'Name' => [ + 'description' => 'The name of the volume. The value of this parameter is the same as the value of the **Volumes.Name** parameter.'."\n", + 'type' => 'string', + 'example' => 'default-volume1', + ], + 'MountPropagation' => [ + 'description' => 'The mount propagation setting of the volume. Mount propagation allows the sharing of volumes that are mounted on one container with other containers in the same pod, or even with other pods on the same node. Valid values:'."\n" + ."\n" + .'* None: The volume mount does not receive subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'* HostToCotainer: The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'* Bidirectional: This value is similar to HostToCotainer. The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories. In addition, all volume mounts that are created by the container are propagated back to the instance and to all containers of all pods that use the same volume.'."\n" + ."\n" + .'Default value: None.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'MountPath' => [ + 'description' => 'The directory on which the volume is mounted.'."\n" + ."\n" + .'> Data in this directory is overwritten by the data on the volume.'."\n", + 'type' => 'string', + 'example' => '/pod/data', + ], + ], + ], + ], + 'EnvironmentVars' => [ + 'description' => 'Information about environment variables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the environment variable.'."\n", + 'type' => 'string', + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => 'The value of the environment variable.'."\n", + 'type' => 'string', + 'example' => '/usr/bin/', + ], + ], + ], + ], + 'Commands' => [ + 'description' => 'The container startup commands. You can specify up to 20 commands. Each command can contain up to 256 characters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The commands that are run in the container when you use the CLI to perform probes.', + 'type' => 'string', + 'example' => 'sleep', + ], + ], + 'LivenessProbeExecCommands' => [ + 'description' => 'The commands that are run in the container when you use the command-line interface (CLI) to perform probes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The commands that are run in the container when you use the command-line interface (CLI) to perform probes.', + 'type' => 'string', + 'example' => 'cat/tmp/healthy', + ], + ], + 'Args' => [ + 'description' => 'The arguments that are passed to the container startup commands. You can specify up to 10 arguments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The arguments that are passed to the container startup commands. You can specify up to 10 arguments.', + 'type' => 'string', + 'example' => '100', + ], + ], + 'ReadinessProbeExecCommands' => [ + 'description' => 'The commands that are run in the container when you use the CLI to perform probes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The commands that are run in the container when you use the CLI to perform probes.', + 'type' => 'string', + 'example' => 'cat/tmp/healthy', + ], + ], + 'SecurityContextCapabilityAdds' => [ + 'description' => 'The permissions that are granted to processes in the container. Only NET_ADMIN and NET_RAW are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permissions that are granted to processes in the container. Only NET_ADMIN and NET_RAW are supported.', + 'type' => 'string', + 'example' => 'NET_ADMIN', + ], + ], + 'LifecyclePostStartHandlerHttpGetHost' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerHttpGetPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePostStartHandlerHttpGetPath' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerHttpGetScheme' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerExecs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'LifecyclePostStartHandlerTcpSocketHost' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerTcpSocketPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePreStopHandlerHttpGetHost' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerHttpGetPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePreStopHandlerHttpGetPath' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerHttpGetScheme' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerExecs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'LifecyclePreStopHandlerTcpSocketHost' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerTcpSocketPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'InitContainers' => [ + 'description' => 'The init containers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The init containers.', + 'type' => 'object', + 'properties' => [ + 'SecurityContextReadOnlyRootFilesystem' => [ + 'description' => 'Indicates whether the root file system is read-only. Valid value: true.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ImagePullPolicy' => [ + 'description' => 'The image pulling policy.'."\n", + 'type' => 'string', + 'example' => 'Always', + ], + 'WorkingDir' => [ + 'description' => 'The working directory.'."\n", + 'type' => 'string', + 'example' => '/usr/local', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'Image' => [ + 'description' => 'The image of the container.'."\n", + 'type' => 'string', + 'example' => 'nginx', + ], + 'Gpu' => [ + 'description' => 'The number of GPUs that are allocated to the container.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityContextRunAsUser' => [ + 'description' => 'The ID of the user that runs the container.'."\n", + 'type' => 'string', + 'example' => '587', + ], + 'Memory' => [ + 'description' => 'The size of the memory.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + 'Name' => [ + 'description' => 'The name of the container.'."\n", + 'type' => 'string', + 'example' => 'test-init', + ], + 'InitContainerEnvironmentVars' => [ + 'description' => 'Information about environment variables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the environment variable.'."\n", + 'type' => 'string', + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => 'The value of the environment variable.'."\n", + 'type' => 'string', + 'example' => '/usr/local/bin', + ], + ], + ], + ], + 'InitContainerVolumeMounts' => [ + 'description' => 'The volumes that are mounted on the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReadOnly' => [ + 'description' => 'Indicates whether the mount path is read-only.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume. The pod can mount different directories of the same volume to different subdirectories of containers.'."\n", + 'type' => 'string', + 'example' => '/usr/sub/', + ], + 'Name' => [ + 'description' => 'The name of the volume.'."\n", + 'type' => 'string', + 'example' => 'test-empty', + ], + 'MountPropagation' => [ + 'description' => 'The mount propagation setting of the volume. Mount propagation allows the sharing of volumes that are mounted on one container with other containers in the same pod, or even with other pods on the same node. Valid values:'."\n" + ."\n" + .'* None: The volume mount does not receive subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'* HostToCotainer: The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'* Bidirectional: This value is similar to HostToCotainer. The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories. In addition, all volume mounts that are created by the container are propagated back to the instance and to all containers of all pods that use the same volume.'."\n" + ."\n" + .'Default value: None.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'MountPath' => [ + 'description' => 'The directory to which the volume is mounted. Data in this directory is overwritten by the data on the volume. Proceed with caution if you use this parameter.'."\n", + 'type' => 'string', + 'example' => '/usr/share/', + ], + ], + ], + ], + 'SecurityContextCapabilityAdds' => [ + 'description' => 'The permissions that are granted to processes in the container. Only NET_ADMIN and NET_RAW are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permissions that are granted to processes in the container. Only NET_ADMIN and NET_RAW are supported.', + 'type' => 'string', + 'example' => 'NET_ADMIN', + ], + ], + 'InitContainerCommands' => [ + 'description' => 'The container startup commands.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The container startup commands.', + 'type' => 'string', + 'example' => 'sleep', + ], + ], + 'InitContainerArgs' => [ + 'description' => 'The container startup arguments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The container startup arguments.', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'Tags' => [ + 'description' => 'The tags of the elastic container instance. The tags are specified in the key-value format.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the elastic container instance. The tags are specified in the key-value format.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'version', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + ], + ], + 'Volumes' => [ + 'description' => 'Information about volumes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Information about volumes.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the volume. Valid values:'."\n" + ."\n" + .'* EmptyDirVolume'."\n" + .'* NFSVolume'."\n" + .'* ConfigFileVolume'."\n" + .'* FlexVolume'."\n", + 'type' => 'string', + 'example' => 'EmptyDirVolume', + ], + 'DiskVolumeDiskId' => [ + 'description' => 'The storage size of the disk volume. Unit: GiB.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'DiskVolumeFsType' => [ + 'description' => 'The file system type of the disk volume.'."\n", + 'type' => 'string', + 'example' => 'xfs', + ], + 'EmptyDirVolumeMedium' => [ + 'description' => 'The storage medium when the **Type** parameter is set to **EmptyDirVolume**. This parameter is left empty by default. If this parameter is left empty, the file system that backs the node is used as the storage medium. If this parameter is set to **memory**, the memory is used as the storage medium.'."\n", + 'type' => 'string', + 'example' => 'memory', + ], + 'NFSVolumePath' => [ + 'description' => 'The path to the Network File System (NFS) volume.'."\n", + 'type' => 'string', + 'example' => '/share', + ], + 'DiskVolumeDiskSize' => [ + 'description' => 'The storage size of the disk volume. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'NFSVolumeReadOnly' => [ + 'description' => 'Indicates whether the NFS volume is read-only.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'FlexVolumeFsType' => [ + 'description' => 'The file system type when the **Type** parameter is set to **FlexVolume**. The default value is determined by the script of the FlexVolume plug-in.'."\n", + 'type' => 'string', + 'example' => 'ext4', + ], + 'ConfigFileVolumeDefaultMode' => [ + 'description' => 'The default permissions on the volume when the **Type** parameter is set to **ConfigFileVolume**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0644', + ], + 'FlexVolumeDriver' => [ + 'description' => 'The name of the driver when the **Type** parameter is set to **FlexVolume**.'."\n", + 'type' => 'string', + 'example' => 'flexvolume', + ], + 'FlexVolumeOptions' => [ + 'description' => 'The options when the **Type** parameter is set to **FlexVolume**. Each object is a key-value pair contained in a JSON string.'."\n" + ."\n" + .'When you use the FlexVolume plug-in to mount a disk, the format of options is `{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}`.'."\n", + 'type' => 'string', + 'example' => '{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}', + ], + 'NFSVolumeServer' => [ + 'description' => 'The endpoint of the NFS server.'."\n", + 'type' => 'string', + 'example' => '3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com', + ], + 'Name' => [ + 'description' => 'The name of the volume.'."\n", + 'type' => 'string', + 'example' => 'default-volume1', + ], + 'ConfigFileVolumeConfigFileToPaths' => [ + 'description' => 'The paths to configuration files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The relative file path.'."\n", + 'type' => 'string', + 'example' => '/usr/bin/', + ], + 'Mode' => [ + 'description' => 'The permissions on the directory when the **Type** parameter is set to **ConfigFileVolume**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0644', + ], + 'Content' => [ + 'description' => 'The content of the configuration file (32 KB).'."\n", + 'type' => 'string', + 'example' => 'bGl1bWk=', + ], + ], + ], + ], + 'EmptyDirVolumeSizeLimit' => [ + 'type' => 'string', + ], + 'HostPathVolumeType' => [ + 'type' => 'string', + ], + 'HostPathVolumePath' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ImageRegistryCredentials' => [ + 'description' => 'The password that is used to access the image repository.', + 'type' => 'array', + 'items' => [ + 'description' => 'The password that is used to access the image repository.', + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => 'The username that is used to access the image repository.', + 'type' => 'string', + 'example' => 'yourpaasword', + ], + 'Server' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.', + 'type' => 'string', + 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com', + ], + 'UserName' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.', + 'type' => 'string', + 'example' => 'yourusername', + ], + ], + ], + ], + 'DnsConfigOptions' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The variable name of the option.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Value' => [ + 'description' => 'The variable value of the option.'."\n", + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'HostAliases' => [ + 'description' => 'The hostnames and IP addresses of a container that are added to the hosts file of the elastic container instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostnames and IP addresses of a container that are added to the hosts file of the elastic container instance.', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address that is added.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'Hostnames' => [ + 'description' => 'The hostnames that are added.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostnames that are added.', + 'type' => 'string', + 'example' => '[\'hehe.com\', \'haha.com\']', + ], + ], + ], + ], + ], + 'SecurityContextSysCtls' => [ + 'description' => 'The system information of the security context in which the elastic container instance runs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The system information of the security context in which the elastic container instance runs.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the security context in which the elastic container instance runs.'."\n", + 'type' => 'string', + 'example' => 'kernel.msgmax', + ], + 'Value' => [ + 'description' => 'The variable value of the security context in which the elastic container instance runs.'."\n", + 'type' => 'string', + 'example' => '65536', + ], + ], + ], + ], + 'AcrRegistryInfos' => [ + 'description' => 'Information about the Container Registry Enterprise Edition instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the Container Registry Enterprise Edition instance.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The ID of the Container Registry Enterprise Edition instance.'."\n", + 'type' => 'string', + 'example' => 'cri-nwj395hgf6f3****', + ], + 'InstanceName' => [ + 'description' => 'The name of the Container Registry Enterprise Edition instance.'."\n", + 'type' => 'string', + 'example' => 'acr-test', + ], + 'RegionId' => [ + 'description' => 'The region ID of the Container Registry Enterprise Edition instance.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Domains' => [ + 'description' => 'The domain names of the Container Registry Enterprise Edition instances. By default, all domain names of the Container Registry Enterprise Edition instances are displayed. You can specify one or more domain names. Separate multiple domain names with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain names of the Container Registry Enterprise Edition instances. By default, all domain names of the Container Registry Enterprise Edition instances are displayed. You can specify one or more domain names. Separate multiple domain names with commas (,).', + 'type' => 'string', + 'example' => '*****-****-registry.cn-beijing.cr.aliyuncs.com', + ], + ], + ], + ], + ], + 'DnsConfigNameServers' => [ + 'description' => 'The IP addresses of the DNS server.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP addresses of the DNS server.', + 'type' => 'string', + 'example' => '172.10.*.**', + ], + ], + 'DnsConfigSearches' => [ + 'description' => 'The lookup domains of the DNS server.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The lookup domains of the DNS server.', + 'type' => 'string', + 'example' => 'svc.local.kubenetes', + ], + ], + 'NtpServers' => [ + 'description' => 'The domain name of the Network Time Protocol (NTP) server.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The domain name of the Network Time Protocol (NTP) server.', + 'type' => 'string', + 'example' => 'ntp.cloud.aliyuncs.com', + ], + ], + 'LifecycleState' => [ + 'description' => 'The state of the scaling configuration in the scaling group. Valid values:'."\n" + ."\n" + .'* Active: The scaling configuration is active in the scaling group. Auto Scaling uses the active scaling configuration to automatically create elastic container instances.'."\n" + .'* Inactive: The scaling configuration is inactive in the scaling group. Auto Scaling does not use the inactive scaling configuration to automatically create elastic container instances. Inactive scaling configurations are retained in the scaling group.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'CostOptimization' => [ + 'description' => 'Indicates whether the cost optimization feature is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'InstanceFamilyLevel' => [ + 'description' => 'The instance family level, which is used to filter instance types that meet the requirements. This parameter is returned when the `CostOptimization` parameter is set to true. Valid values:'."\n" + ."\n" + .'* EntryLevel: shared instance type. Instances of this level are the most cost-effective but may not provide stable computing performance in a consistent manner. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see [Shared instance families](~~108489~~).'."\n" + .'* EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see [Instance family](~~25378~~).'."\n" + .'* CreditEntryLevel: This value is available only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see [Overview](~~59977~~) of burstable instances.'."\n", + 'type' => 'string', + 'example' => 'EnterpriseLevel', + ], + 'InstanceTypes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'DataCacheBucket' => [ + 'type' => 'string', + ], + 'DataCachePL' => [ + 'type' => 'string', + ], + 'DataCacheProvisionedIops' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'DataCacheBurstingEnabled' => [ + 'type' => 'boolean', + ], + 'GpuDriverVersion' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Forbidden.RiskControl', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"TotalCount\\": 1,\\n \\"ScalingConfigurations\\": [\\n {\\n \\"CreationTime\\": \\"2014-08-14T10:58Z\\",\\n \\"ScalingConfigurationName\\": \\"scalingconfi****\\",\\n \\"SecurityGroupId\\": \\"sg-bp18kz60mefs****\\",\\n \\"ActiveDeadlineSeconds\\": 1000,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"AutoCreateEip\\": true,\\n \\"ScalingGroupId\\": \\"asg-bp17pelvl720x3v7****\\",\\n \\"EphemeralStorage\\": 20,\\n \\"Ipv6AddressCount\\": 1,\\n \\"EipBandwidth\\": 5,\\n \\"ImageSnapshotId\\": \\"imc-2zebxkiifuyzzlhl****\\",\\n \\"Memory\\": 16,\\n \\"RestartPolicy\\": \\"Never\\",\\n \\"SpotPriceLimit\\": 0.025,\\n \\"IngressBandwidth\\": 1024000,\\n \\"CpuOptionsThreadsPerCore\\": 2,\\n \\"TerminationGracePeriodSeconds\\": 60,\\n \\"LoadBalancerWeight\\": 1,\\n \\"DnsPolicy\\": \\"Default\\",\\n \\"HostName\\": \\"[\'hehe.com\', \'haha.com\']\\",\\n \\"EgressBandwidth\\": 1024000,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RamRoleName\\": \\"ram:PassRole\\",\\n \\"Cpu\\": 2,\\n \\"AutoMatchImageCache\\": false,\\n \\"ResourceGroupId\\": \\"rg-8db03793gfrz****\\",\\n \\"ContainerGroupName\\": \\"test\\",\\n \\"ScalingConfigurationId\\": \\"asc-bp1ezrfgoyn5kijl****\\",\\n \\"CpuOptionsCore\\": 2,\\n \\"Containers\\": [\\n {\\n \\"ReadinessProbeHttpGetPath\\": \\"/usr/local\\",\\n \\"ReadinessProbeSuccessThreshold\\": 1,\\n \\"LivenessProbePeriodSeconds\\": 5,\\n \\"LivenessProbeTcpSocketPort\\": 80,\\n \\"LivenessProbeHttpGetScheme\\": \\"HTTP\\",\\n \\"WorkingDir\\": \\"/usr/local/nginx\\",\\n \\"Tty\\": false,\\n \\"LivenessProbeHttpGetPort\\": 80,\\n \\"Gpu\\": 1,\\n \\"ReadinessProbeInitialDelaySeconds\\": 5,\\n \\"Stdin\\": true,\\n \\"Memory\\": 2,\\n \\"Name\\": \\"nginx\\",\\n \\"LivenessProbeHttpGetPath\\": \\"/usr/nginx/\\",\\n \\"Image\\": \\"mysql\\",\\n \\"ReadinessProbeTcpSocketPort\\": 8888,\\n \\"ReadinessProbeHttpGetScheme\\": \\"HTTP\\",\\n \\"ReadinessProbeHttpGetPort\\": 0,\\n \\"LivenessProbeSuccessThreshold\\": 1,\\n \\"ReadinessProbeTimeoutSeconds\\": 5,\\n \\"SecurityContextRunAsUser\\": 1000,\\n \\"LivenessProbeInitialDelaySeconds\\": 10,\\n \\"ReadinessProbePeriodSeconds\\": 1,\\n \\"ImagePullPolicy\\": \\"Always\\",\\n \\"StdinOnce\\": true,\\n \\"Cpu\\": 2,\\n \\"LivenessProbeTimeoutSeconds\\": 10,\\n \\"ReadinessProbeFailureThreshold\\": 3,\\n \\"LivenessProbeFailureThreshold\\": 3,\\n \\"Ports\\": [\\n {\\n \\"Port\\": 8888,\\n \\"Protocol\\": \\"TCP\\"\\n }\\n ],\\n \\"VolumeMounts\\": [\\n {\\n \\"ReadOnly\\": false,\\n \\"SubPath\\": \\"data2/\\",\\n \\"Name\\": \\"default-volume1\\",\\n \\"MountPropagation\\": \\"None\\",\\n \\"MountPath\\": \\"/pod/data\\"\\n }\\n ],\\n \\"EnvironmentVars\\": [\\n {\\n \\"Key\\": \\"PATH\\",\\n \\"Value\\": \\"/usr/bin/\\"\\n }\\n ],\\n \\"Commands\\": [\\n \\"sleep\\"\\n ],\\n \\"LivenessProbeExecCommands\\": [\\n \\"cat/tmp/healthy\\"\\n ],\\n \\"Args\\": [\\n \\"100\\"\\n ],\\n \\"ReadinessProbeExecCommands\\": [\\n \\"cat/tmp/healthy\\"\\n ],\\n \\"SecurityContextCapabilityAdds\\": [\\n \\"NET_ADMIN\\"\\n ],\\n \\"LifecyclePostStartHandlerHttpGetHost\\": \\"10.0.XX.XX\\",\\n \\"LifecyclePostStartHandlerHttpGetPort\\": 80,\\n \\"LifecyclePostStartHandlerHttpGetPath\\": \\"/healthyz\\",\\n \\"LifecyclePostStartHandlerHttpGetScheme\\": \\"HTTP\\",\\n \\"LifecyclePostStartHandlerExecs\\": [\\n \\"[ \\\\\\"/bin/sh\\\\\\", \\\\\\"-c\\\\\\", \\\\\\"echo Hello from the preStop handler /usr/share/message\\\\\\" ]\\"\\n ],\\n \\"LifecyclePostStartHandlerTcpSocketHost\\": \\"10.0.XX.XX\\",\\n \\"LifecyclePostStartHandlerTcpSocketPort\\": 80,\\n \\"LifecyclePreStopHandlerHttpGetHost\\": \\"10.0.XX.XX\\",\\n \\"LifecyclePreStopHandlerHttpGetPort\\": 80,\\n \\"LifecyclePreStopHandlerHttpGetPath\\": \\"/healthyz\\",\\n \\"LifecyclePreStopHandlerHttpGetScheme\\": \\"HTTP\\",\\n \\"LifecyclePreStopHandlerExecs\\": [\\n \\"[ \\\\\\"/bin/sh\\\\\\", \\\\\\"-c\\\\\\", \\\\\\"echo Hello from the preStop handler /usr/share/message\\\\\\" ]\\"\\n ],\\n \\"LifecyclePreStopHandlerTcpSocketHost\\": \\"10.0.XX.XX\\",\\n \\"LifecyclePreStopHandlerTcpSocketPort\\": 80\\n }\\n ],\\n \\"InitContainers\\": [\\n {\\n \\"SecurityContextReadOnlyRootFilesystem\\": true,\\n \\"ImagePullPolicy\\": \\"Always\\",\\n \\"WorkingDir\\": \\"/usr/local\\",\\n \\"Cpu\\": 0.5,\\n \\"Image\\": \\"nginx\\",\\n \\"Gpu\\": 1,\\n \\"SecurityContextRunAsUser\\": \\"587\\",\\n \\"Memory\\": 1,\\n \\"Name\\": \\"test-init\\",\\n \\"InitContainerEnvironmentVars\\": [\\n {\\n \\"Key\\": \\"PATH\\",\\n \\"Value\\": \\"/usr/local/bin\\"\\n }\\n ],\\n \\"InitContainerVolumeMounts\\": [\\n {\\n \\"ReadOnly\\": false,\\n \\"SubPath\\": \\"/usr/sub/\\",\\n \\"Name\\": \\"test-empty\\",\\n \\"MountPropagation\\": \\"None\\",\\n \\"MountPath\\": \\"/usr/share/\\"\\n }\\n ],\\n \\"SecurityContextCapabilityAdds\\": [\\n \\"NET_ADMIN\\"\\n ],\\n \\"InitContainerCommands\\": [\\n \\"sleep\\"\\n ],\\n \\"InitContainerArgs\\": [\\n \\"10\\"\\n ]\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"version\\",\\n \\"Value\\": \\"3\\"\\n }\\n ],\\n \\"Volumes\\": [\\n {\\n \\"Type\\": \\"EmptyDirVolume\\",\\n \\"DiskVolumeDiskId\\": \\"15\\",\\n \\"DiskVolumeFsType\\": \\"xfs\\",\\n \\"EmptyDirVolumeMedium\\": \\"memory\\",\\n \\"NFSVolumePath\\": \\"/share\\",\\n \\"DiskVolumeDiskSize\\": 15,\\n \\"NFSVolumeReadOnly\\": false,\\n \\"FlexVolumeFsType\\": \\"ext4\\",\\n \\"ConfigFileVolumeDefaultMode\\": 644,\\n \\"FlexVolumeDriver\\": \\"flexvolume\\",\\n \\"FlexVolumeOptions\\": \\"{\\\\\\"volumeId\\\\\\":\\\\\\"d-2zehdahrwoa7srg****\\\\\\",\\\\\\"performanceLevel\\\\\\": \\\\\\"PL2\\\\\\"}\\",\\n \\"NFSVolumeServer\\": \\"3f9cd4****-na***.cn-shanghai.nas.aliyuncs.com\\",\\n \\"Name\\": \\"default-volume1\\",\\n \\"ConfigFileVolumeConfigFileToPaths\\": [\\n {\\n \\"Path\\": \\"/usr/bin/\\",\\n \\"Mode\\": 644,\\n \\"Content\\": \\"bGl1bWk=\\"\\n }\\n ],\\n \\"EmptyDirVolumeSizeLimit\\": \\"256 Mi\\",\\n \\"HostPathVolumeType\\": \\"Directory\\",\\n \\"HostPathVolumePath\\": \\"/pod/data\\"\\n }\\n ],\\n \\"ImageRegistryCredentials\\": [\\n {\\n \\"Password\\": \\"yourpaasword\\",\\n \\"Server\\": \\"registry-vpc.cn-shanghai.aliyuncs.com\\",\\n \\"UserName\\": \\"yourusername\\"\\n }\\n ],\\n \\"DnsConfigOptions\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"HostAliases\\": [\\n {\\n \\"Ip\\": \\"192.0.XX.XX\\",\\n \\"Hostnames\\": [\\n \\"[\'hehe.com\', \'haha.com\']\\"\\n ]\\n }\\n ],\\n \\"SecurityContextSysCtls\\": [\\n {\\n \\"Name\\": \\"kernel.msgmax\\",\\n \\"Value\\": \\"65536\\"\\n }\\n ],\\n \\"AcrRegistryInfos\\": [\\n {\\n \\"InstanceId\\": \\"cri-nwj395hgf6f3****\\",\\n \\"InstanceName\\": \\"acr-test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Domains\\": [\\n \\"*****-****-registry.cn-beijing.cr.aliyuncs.com\\"\\n ]\\n }\\n ],\\n \\"DnsConfigNameServers\\": [\\n \\"172.10.*.**\\"\\n ],\\n \\"DnsConfigSearches\\": [\\n \\"svc.local.kubenetes\\"\\n ],\\n \\"NtpServers\\": [\\n \\"ntp.cloud.aliyuncs.com\\"\\n ],\\n \\"LifecycleState\\": \\"Active\\",\\n \\"CostOptimization\\": false,\\n \\"InstanceFamilyLevel\\": \\"EnterpriseLevel\\",\\n \\"InstanceTypes\\": [\\n \\"ecs.g6.large\\"\\n ],\\n \\"DataCacheBucket\\": \\"default\\",\\n \\"DataCachePL\\": \\"PL1\\",\\n \\"DataCacheProvisionedIops\\": 40000,\\n \\"DataCacheBurstingEnabled\\": false,\\n \\"GpuDriverVersion\\": \\"tesla=470.82.01\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeEciScalingConfigurationsResponse>\\n <PageNumber>1</PageNumber>\\n <PageSize>50</PageSize>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <TotalCount>1</TotalCount>\\n <ScalingConfigurations>\\n <CreationTime>2014-08-14T10:58Z</CreationTime>\\n <ScalingConfigurationName>scalingconfi****</ScalingConfigurationName>\\n <SecurityGroupId>sg-bp18kz60mefs****</SecurityGroupId>\\n <ActiveDeadlineSeconds>1000</ActiveDeadlineSeconds>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n <AutoCreateEip>true</AutoCreateEip>\\n <ScalingGroupId>asg-bp17pelvl720x3v7****</ScalingGroupId>\\n <EphemeralStorage>20</EphemeralStorage>\\n <Ipv6AddressCount>1</Ipv6AddressCount>\\n <EipBandwidth>5</EipBandwidth>\\n <ImageSnapshotId>imc-2zebxkiifuyzzlhl****</ImageSnapshotId>\\n <Memory>16</Memory>\\n <RestartPolicy>Never</RestartPolicy>\\n <SpotPriceLimit>0.025</SpotPriceLimit>\\n <IngressBandwidth>1024000</IngressBandwidth>\\n <CpuOptionsThreadsPerCore>2</CpuOptionsThreadsPerCore>\\n <TerminationGracePeriodSeconds>60</TerminationGracePeriodSeconds>\\n <LoadBalancerWeight>1</LoadBalancerWeight>\\n <DnsPolicy>Default</DnsPolicy>\\n <HostName>[\'hehe.com\', \'haha.com\']</HostName>\\n <EgressBandwidth>1024000</EgressBandwidth>\\n <RegionId>cn-hangzhou</RegionId>\\n <RamRoleName>ram:PassRole</RamRoleName>\\n <Cpu>2</Cpu>\\n <AutoMatchImageCache>false</AutoMatchImageCache>\\n <ResourceGroupId>rg-8db03793gfrz****</ResourceGroupId>\\n <ContainerGroupName>test</ContainerGroupName>\\n <ScalingConfigurationId>asc-bp1ezrfgoyn5kijl****</ScalingConfigurationId>\\n <CpuOptionsCore>2</CpuOptionsCore>\\n <Containers>\\n <ReadinessProbeHttpGetPath>/usr/local</ReadinessProbeHttpGetPath>\\n <ReadinessProbeSuccessThreshold>1</ReadinessProbeSuccessThreshold>\\n <LivenessProbePeriodSeconds>5</LivenessProbePeriodSeconds>\\n <LivenessProbeTcpSocketPort>80</LivenessProbeTcpSocketPort>\\n <LivenessProbeHttpGetScheme>HTTP</LivenessProbeHttpGetScheme>\\n <WorkingDir>/usr/local/nginx</WorkingDir>\\n <Tty>false</Tty>\\n <LivenessProbeHttpGetPort>80</LivenessProbeHttpGetPort>\\n <Gpu>1</Gpu>\\n <ReadinessProbeInitialDelaySeconds>5</ReadinessProbeInitialDelaySeconds>\\n <Stdin>true</Stdin>\\n <Memory>2</Memory>\\n <Name>nginx</Name>\\n <LivenessProbeHttpGetPath>/usr/nginx/</LivenessProbeHttpGetPath>\\n <Image>mysql</Image>\\n <ReadinessProbeTcpSocketPort>8888</ReadinessProbeTcpSocketPort>\\n <ReadinessProbeHttpGetScheme>HTTP</ReadinessProbeHttpGetScheme>\\n <LivenessProbeSuccessThreshold>1</LivenessProbeSuccessThreshold>\\n <ReadinessProbeTimeoutSeconds>5</ReadinessProbeTimeoutSeconds>\\n <SecurityContextRunAsUser>1000</SecurityContextRunAsUser>\\n <LivenessProbeInitialDelaySeconds>10</LivenessProbeInitialDelaySeconds>\\n <ReadinessProbePeriodSeconds>1</ReadinessProbePeriodSeconds>\\n <ImagePullPolicy>Always</ImagePullPolicy>\\n <StdinOnce>true</StdinOnce>\\n <Cpu>2</Cpu>\\n <LivenessProbeTimeoutSeconds>10</LivenessProbeTimeoutSeconds>\\n <ReadinessProbeFailureThreshold>3</ReadinessProbeFailureThreshold>\\n <LivenessProbeFailureThreshold>3</LivenessProbeFailureThreshold>\\n <Ports>\\n <Port>8888</Port>\\n <Protocol>TCP</Protocol>\\n </Ports>\\n <VolumeMounts>\\n <ReadOnly>false</ReadOnly>\\n <SubPath>data2/</SubPath>\\n <Name>default-volume1</Name>\\n <MountPropagation>None</MountPropagation>\\n <MountPath>/pod/data</MountPath>\\n </VolumeMounts>\\n <EnvironmentVars>\\n <Key>PATH</Key>\\n <Value>/usr/bin/</Value>\\n </EnvironmentVars>\\n <Commands>sleep</Commands>\\n <LivenessProbeExecCommands>cat/tmp/healthy</LivenessProbeExecCommands>\\n <Args>100</Args>\\n <ReadinessProbeExecCommands>cat/tmp/healthy</ReadinessProbeExecCommands>\\n <SecurityContextCapabilityAdds>NET_ADMIN</SecurityContextCapabilityAdds>\\n <LifecyclePostStartHandlerHttpGetHost>10.0.XX.XX</LifecyclePostStartHandlerHttpGetHost>\\n <LifecyclePostStartHandlerHttpGetPort>80</LifecyclePostStartHandlerHttpGetPort>\\n <LifecyclePostStartHandlerHttpGetPath>/healthyz</LifecyclePostStartHandlerHttpGetPath>\\n <LifecyclePostStartHandlerHttpGetScheme>HTTP</LifecyclePostStartHandlerHttpGetScheme>\\n <LifecyclePostStartHandlerExecs>[ \\"/bin/sh\\", \\"-c\\", \\"echo Hello from the preStop handler /usr/share/message\\" ]</LifecyclePostStartHandlerExecs>\\n <LifecyclePostStartHandlerTcpSocketHost>10.0.XX.XX</LifecyclePostStartHandlerTcpSocketHost>\\n <LifecyclePostStartHandlerTcpSocketPort>80</LifecyclePostStartHandlerTcpSocketPort>\\n <LifecyclePreStopHandlerHttpGetHost>10.0.XX.XX</LifecyclePreStopHandlerHttpGetHost>\\n <LifecyclePreStopHandlerHttpGetPort>80</LifecyclePreStopHandlerHttpGetPort>\\n <LifecyclePreStopHandlerHttpGetPath>/healthyz</LifecyclePreStopHandlerHttpGetPath>\\n <LifecyclePreStopHandlerHttpGetScheme>HTTP</LifecyclePreStopHandlerHttpGetScheme>\\n <LifecyclePreStopHandlerExecs>[ \\"/bin/sh\\", \\"-c\\", \\"echo Hello from the preStop handler /usr/share/message\\" ]</LifecyclePreStopHandlerExecs>\\n <LifecyclePreStopHandlerTcpSocketHost>10.0.XX.XX</LifecyclePreStopHandlerTcpSocketHost>\\n <LifecyclePreStopHandlerTcpSocketPort>80</LifecyclePreStopHandlerTcpSocketPort>\\n </Containers>\\n <InitContainers>\\n <SecurityContextReadOnlyRootFilesystem>true</SecurityContextReadOnlyRootFilesystem>\\n <ImagePullPolicy>Always</ImagePullPolicy>\\n <WorkingDir>/usr/local</WorkingDir>\\n <Cpu>0.5</Cpu>\\n <Image>nginx</Image>\\n <Gpu>1</Gpu>\\n <SecurityContextRunAsUser>587</SecurityContextRunAsUser>\\n <Memory>1</Memory>\\n <Name>test-init</Name>\\n <InitContainerEnvironmentVars>\\n <Key>PATH</Key>\\n <Value>/usr/local/bin</Value>\\n </InitContainerEnvironmentVars>\\n <InitContainerVolumeMounts>\\n <ReadOnly>false</ReadOnly>\\n <SubPath>/usr/sub/</SubPath>\\n <Name>test-empty</Name>\\n <MountPropagation>None</MountPropagation>\\n <MountPath>/usr/share/</MountPath>\\n </InitContainerVolumeMounts>\\n <SecurityContextCapabilityAdds>NET_ADMIN</SecurityContextCapabilityAdds>\\n <InitContainerCommands>sleep</InitContainerCommands>\\n <InitContainerArgs>10</InitContainerArgs>\\n </InitContainers>\\n <Tags>\\n <Key>version</Key>\\n <Value>3</Value>\\n </Tags>\\n <Volumes>\\n <Type>EmptyDirVolume</Type>\\n <DiskVolumeDiskId>15</DiskVolumeDiskId>\\n <DiskVolumeFsType>xfs</DiskVolumeFsType>\\n <EmptyDirVolumeMedium>memory</EmptyDirVolumeMedium>\\n <NFSVolumePath>/share</NFSVolumePath>\\n <DiskVolumeDiskSize>15</DiskVolumeDiskSize>\\n <NFSVolumeReadOnly>false</NFSVolumeReadOnly>\\n <FlexVolumeFsType>ext4</FlexVolumeFsType>\\n <ConfigFileVolumeDefaultMode>644</ConfigFileVolumeDefaultMode>\\n <FlexVolumeDriver>flexvolume</FlexVolumeDriver>\\n <FlexVolumeOptions>{\\"volumeId\\":\\"d-2zehdahrwoa7srg****\\",\\"performanceLevel\\": \\"PL2\\"}</FlexVolumeOptions>\\n <NFSVolumeServer>3f9cd4****-na***.cn-shanghai.nas.aliyuncs.com</NFSVolumeServer>\\n <Name>default-volume1</Name>\\n <ConfigFileVolumeConfigFileToPaths>\\n <Path>/usr/bin/</Path>\\n <Mode>644</Mode>\\n <Content>bGl1bWk=</Content>\\n </ConfigFileVolumeConfigFileToPaths>\\n <EmptyDirVolumeSizeLimit>256 Mi</EmptyDirVolumeSizeLimit>\\n <HostPathVolumeType>Directory</HostPathVolumeType>\\n <HostPathVolumePath>/pod/data</HostPathVolumePath>\\n </Volumes>\\n <ImageRegistryCredentials>\\n <Password>yourpaasword</Password>\\n <Server>registry-vpc.cn-shanghai.aliyuncs.com</Server>\\n <UserName>yourusername</UserName>\\n </ImageRegistryCredentials>\\n <DnsConfigOptions>\\n <Name>name</Name>\\n <Value>value</Value>\\n </DnsConfigOptions>\\n <HostAliases>\\n <Ip>192.0.XX.XX</Ip>\\n <Hostnames>[\'hehe.com\', \'haha.com\']</Hostnames>\\n </HostAliases>\\n <SecurityContextSysCtls>\\n <Name>kernel.msgmax</Name>\\n <Value>65536</Value>\\n </SecurityContextSysCtls>\\n <AcrRegistryInfos>\\n <InstanceId>cri-nwj395hgf6f3****</InstanceId>\\n <InstanceName>acr-test</InstanceName>\\n <RegionId>cn-hangzhou</RegionId>\\n <Domains>*****-****-registry.cn-beijing.cr.aliyuncs.com</Domains>\\n </AcrRegistryInfos>\\n <DnsConfigNameServers>172.10.*.**</DnsConfigNameServers>\\n <DnsConfigSearches>svc.local.kubenetes</DnsConfigSearches>\\n <NtpServers>ntp.cloud.aliyuncs.com</NtpServers>\\n <LifecycleState>Active</LifecycleState>\\n <CostOptimization>false</CostOptimization>\\n <InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>\\n <InstanceTypes>ecs.g6.large</InstanceTypes>\\n <DataCacheBucket>default</DataCacheBucket>\\n <DataCachePL>PL1</DataCachePL>\\n <DataCacheProvisionedIops>40000</DataCacheProvisionedIops>\\n <DataCacheBurstingEnabled>false</DataCacheBurstingEnabled>\\n <GpuDriverVersion>tesla=470.82.01</GpuDriverVersion>\\n </ScalingConfigurations>\\n</DescribeEciScalingConfigurationsResponse>","errorExample":""}]', + 'title' => 'DescribeEciScalingConfigurations', + ], + 'DetachAlbServerGroups' => [ + 'summary' => '移出一个或多个ALB服务器组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92688', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the scaling group resides. Examples: cn-hangzhou and cn-shanghai. For more information, see [Regions and zones](~~40654~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n" + ."\n" + .'The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ForceDetach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove existing Elastic Compute Service (ECS) instances from the ALB server group that you want to disassociate from the scaling group.'."\n" + ."\n" + .'* true: removes existing ECS instances and returns the `ScalingActivityId` value. You can view the ID of the scaling activity to determine whether the instances are removed.'."\n" + .'* false: does not remove existing ECS instances.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AlbServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ALB server groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlbServerGroupId' => [ + 'description' => 'The ID of ALB server group N. N indicates the serial number of the ALB server group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sgp-ddwb0y0g6y9bjm****', + ], + 'Port' => [ + 'description' => 'The port number used by the ECS instances in ALB server group N. N indicates the serial number of the ALB server group.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '22', + ], + ], + 'required' => false, + 'description' => 'The ALB server groups.', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity in which the ALB server group is disassociated from the scaling group and the ECS instances in the ALB server group are removed from the ALB server group. This parameter is valid only when you set `ForceDetach` to `true`.'."\n", + 'type' => 'string', + 'example' => 'asa-2ze6wxj8vsohn6j9****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-2ze6wxj8vsohn6j9****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachAlbServerGroupsResponse>\\n <ScalingActivityId>asa-2ze6wxj8vsohn6j9****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</DetachAlbServerGroupsResponse>","errorExample":""}]', + 'title' => 'DetachAlbServerGroups', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=DetachAlbServerGroups\\&type=RPC\\&version=2014-08-28)'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ModifyEciScalingConfiguration' => [ + 'summary' => '修改一个ECI类型伸缩配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92705', + 'abilityTreeNodes' => [ + 'FEATUREessT4M3WE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingConfigurationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling configuration that you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asc-bp16har3jpj6fjbx****', + ], + ], + [ + 'name' => 'ScalingConfigurationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the scaling configuration. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (\\_), hyphens (-), and periods (.). The name must start with a letter or a digit.'."\n" + ."\n" + .'The name of the scaling configuration must be unique within a scaling group in a region. If you do not specify this parameter, the value of the ScalingConfigurationId parameter is used.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test-modify', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group with which you want to associate the elastic container instance. Elastic container instances that are associated with the same security group can communicate with each other.'."\n" + ."\n" + .'If you do not specify a security group, the system uses the default security group in the region that you select. Make sure that the inbound rules of the security group contain the protocols and the port numbers of the containers that you want to expose. If you do not have a default security group in the region, the system automatically creates a default security group and adds the declared container protocols and port numbers to the inbound rules of the security group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'sg-uf66jeqopgqa9hdn****', + ], + ], + [ + 'name' => 'ContainerGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the elastic container instance. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must be 2 to 128 characters in length.'."\n" + .'* The name can contain only lowercase letters, digits, and hyphens (-). The name cannot start or end with a hyphen (-).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'nginx-test', + ], + ], + [ + 'name' => 'RestartPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The restart policy of the elastic container instance. Valid values:'."\n" + ."\n" + .'* Always: always restarts the elastic container instance.'."\n" + .'* Never: never restarts the elastic container instance.'."\n" + .'* OnFailure: restarts the elastic container instance upon failures.'."\n" + ."\n" + .'Default value: Always.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Always', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of vCPUs of the elastic container instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The memory size of the elastic container instance. Unit: GiB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2.0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-uf66jeqopgqa9hdn****', + ], + ], + [ + 'name' => 'DnsPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Domain Name System (DNS) policy. Valid values:'."\n" + ."\n" + .'* None: uses the DNS that is specified for the DnsConfig field.'."\n" + .'* Default: uses the DNS that is specified for the runtime environment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'ImageSnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the image cache snapshot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'imc-2zebxkiifuyzzlhl****', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the RAM role of the instance. You can use a RAM role to access elastic container instances and Elastic Compute Service (ECS) instances. For more information, see [Use an instance RAM role by calling API operations](~~61178~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RamTestRole', + ], + ], + [ + 'name' => 'TerminationGracePeriodSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The buffer time during which the program handles operations before the program stops. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'AutoMatchImageCache', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically match the image cache. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Ipv6AddressCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of IPv6 addresses.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ActiveDeadlineSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the scaling configuration. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bidding policy of the elastic container instance. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is a preemptible instance that has a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SpotPriceLimit', + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the preemptible elastic container instance. The value can be accurate to three decimal places.'."\n" + ."\n" + .'If you set the SpotStrategy parameter to SpotWithPriceLimit, you must specify the SpotPriceLimit parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.025', + ], + ], + [ + 'name' => 'AutoCreateEip', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically create an elastic IP address (EIP), and then bind the EIP to the elastic container instance.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EipBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bandwidth of the EIP.'."\n" + ."\n" + .'Default value: 5. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000000', + 'minimum' => '0', + 'example' => '5', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname of the elastic container instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IngressBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum inbound bandwidth. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1024000', + ], + ], + [ + 'name' => 'EgressBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum outbound bandwidth. Unit: bit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1024000', + ], + ], + [ + 'name' => 'CpuOptionsCore', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of physical CPU cores. You can specify this parameter only for specific instance types. For more information, see [Customize CPU options](~~197781~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'CpuOptionsThreadsPerCore', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of threads per core. You can specify this parameter only for specific instance types. If you set this parameter to 1, Hyper-Threading is disabled. For more information, see [Customize CPU options](~~197781~~).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'EphemeralStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the temporary storage space. By default, an enhanced SSD (ESSD) of the PL1 level is used. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '0', + 'example' => '20', + ], + ], + [ + 'name' => 'LoadBalancerWeight', + 'in' => 'query', + 'schema' => [ + 'description' => 'The weight of the elastic container instance as a backend server. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'version', + ], + 'Value' => [ + 'description' => 'The value of tag N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ImageRegistryCredential', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the image repository.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the image repository.', + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => 'The password that is used to access image repository N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yourpaasword', + ], + 'Server' => [ + 'description' => 'The address of image repository N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com', + ], + 'UserName' => [ + 'description' => 'The username that is used to access image repository N.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yourusername', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 11, + ], + ], + [ + 'name' => 'Container', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The minimum number of consecutive successes before a failed probe is considered successful. Default value: 1. Valid value: 1.', + 'type' => 'array', + 'items' => [ + 'description' => 'The minimum number of consecutive successes before a failed probe is considered successful. Default value: 1. Valid value: 1.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReadinessProbe.TimeoutSeconds' => [ + 'description' => 'The timeout period for the probe. Unit: seconds. Default value: 1. Minimum value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ReadinessProbe.SuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes for the probe to be considered successful after having failed. Default value: 1. Set the value to 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SecurityContext.Capability.Add' => [ + 'description' => 'The permissions granted to processes in the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permissions that you want to grant to the processes in container N. Valid values: NET_ADMIN and NET_RAW.'."\n" + ."\n" + .'> To use NET_RAW, you must submit a ticket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NET_ADMIN', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ReadinessProbe.TcpSocket.Port' => [ + 'description' => 'The port detected by TCP sockets when you use TCP sockets to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8000', + ], + 'ReadinessProbe.HttpGet.Scheme' => [ + 'description' => 'The protocol type of HTTP GET requests when you use HTTP requests to perform health checks. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'LivenessProbe.PeriodSeconds' => [ + 'description' => 'The interval at which probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Port' => [ + 'description' => 'Information about the ports.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the ports.', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => 'The type of the protocol. Valid values:'."\n" + ."\n" + .'* TCP'."\n" + .'* UDP'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'Port' => [ + 'description' => 'The port number. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + 'SecurityContext.ReadOnlyRootFilesystem' => [ + 'description' => 'Specifies whether permissions on the root file system are read-only. Set the value to true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'EnvironmentVar' => [ + 'description' => 'Information about the environment variables.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the environment variables.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the environment variable. Specify the name in the `[0-9a-zA-Z]` format. The name must be 1 to 128 characters in length, and can contain underscores (_). It cannot start with a digit.', + 'type' => 'string', + 'required' => false, + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => 'The value of the environment variable. The value must be 0 to 256 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/bin', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 301, + ], + 'LivenessProbe.TcpSocket.Port' => [ + 'description' => 'The port detected by TCP sockets when you use TCP sockets to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8000', + ], + 'Tty' => [ + 'description' => 'Specifies whether to enable interaction. Default value: false.'."\n" + ."\n" + .'If the command is a /bin/bash command, set the value to true.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'WorkingDir' => [ + 'description' => 'The working directory of the container.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/', + ], + 'LivenessProbe.HttpGet.Scheme' => [ + 'description' => 'The protocol type of HTTP GET requests when you use HTTP requests to perform health checks. Valid values:'."\n" + ."\n" + .'* HTTP'."\n" + .'* HTTPS'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'ReadinessProbe.HttpGet.Port' => [ + 'description' => 'The port to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8080', + ], + 'Arg' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'array', + 'items' => [ + 'description' => 'The arguments that correspond to the startup commands of the container. You can specify up to 10 arguments.', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'Gpu' => [ + 'description' => 'The number of GPUs that you want to allocate to the container.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ReadinessProbe.InitialDelaySeconds' => [ + 'description' => 'The time period after the container is started and before the probe is initiated. Unit: seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Stdin' => [ + 'description' => 'Specifies whether the container allocates buffer resources to standard input streams when the container is running. If you do not specify this parameter, an end-of-file (EOF) error may occur.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Memory' => [ + 'description' => 'The memory size of the container. Unit: GiB.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'Name' => [ + 'description' => 'The name of the container image.', + 'type' => 'string', + 'required' => false, + 'example' => 'nginx', + ], + 'Image' => [ + 'description' => 'The image of the container.', + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest', + ], + 'LivenessProbe.InitialDelaySeconds' => [ + 'description' => 'The time period after the container is started and before the probe is initiated. Unit: seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'VolumeMount' => [ + 'description' => 'Information about the volume mount of the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the volume mount of the container.', + 'type' => 'object', + 'properties' => [ + 'MountPropagation' => [ + 'description' => 'The mount propagation setting of the volume. Mount propagation allows volumes that are mounted on one container to be shared with other containers in the same pod, or even with other pods on the same node. Valid values:'."\n" + ."\n" + .'* None: This volume mount does not receive subsequent mounts that are mounted to this volume or subdirectories of this volume by the host.'."\n" + .'* HostToCotainer: This volume mount receives all subsequent mounts that are mounted to this volume or subdirectories of this volume.'."\n" + .'* Bidirectional: The volume mount behaves the same as the HostToCotainer mount. The volume mount receives all subsequent mounts that are mounted to this volume or subdirectories of this volume. In addition, all volume mounts created by the container are propagated back to the host and to all containers of all pods that use the same volume.'."\n" + ."\n" + .'Default value: None.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'None', + ], + 'MountPath' => [ + 'description' => 'The path where the container mounts the volume.'."\n" + ."\n" + .'>Data stored in the path of the container is directly overwritten by the content of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => '/pod/data', + ], + 'ReadOnly' => [ + 'description' => 'Specifies whether the volume is read-only.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Name' => [ + 'description' => 'The name of the volume. The value of this parameter is the same as the value of the Volumes.Name parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'default-volume1', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'data2/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + 'LivenessProbe.FailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures for the probe to be considered failed after having been successful.'."\n" + ."\n" + .'Default value: 3.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ReadinessProbe.Exec.Command' => [ + 'description' => 'The commands executed in the container when using the command line to perform the health check.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command.', + 'type' => 'string', + 'required' => false, + 'example' => 'cat/tmp/healthy', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'ReadinessProbe.FailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures for the probe to be considered failed after having been successful.'."\n" + ."\n" + .'Default value: 3.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ImagePullPolicy' => [ + 'description' => 'The policy that you want to use to pull an image. Valid values:'."\n" + ."\n" + .'* Always: Each time instances are created, image pulling is performed.'."\n" + .'* IfNotPresent: Image pulling is performed as needed. On-premises images are preferentially used. If no on-premises images are available, image pulling is performed.'."\n" + .'* Never: On-premises images are always used. Image pulling is not performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Always', + ], + 'StdinOnce' => [ + 'description' => 'Specifies whether standard input streams are disconnected after a client is disconnected.'."\n" + ."\n" + .'If you set the StdinOnce parameter to true, standard input streams are connected after the container is started, and remain idle until a client is connected to receive data. After the client is disconnected, streams are also disconnected, and remain disconnected until the container is started again.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs that you want to allocate to the container.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'LivenessProbe.HttpGet.Port' => [ + 'description' => 'The port to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8888', + ], + 'LivenessProbe.HttpGet.Path' => [ + 'description' => 'The path to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'string', + 'required' => false, + 'example' => '/healthyz', + ], + 'LivenessProbe.SuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes for the probe to be considered successful after having failed. Default value: 1. Set the value to 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ReadinessProbe.PeriodSeconds' => [ + 'description' => 'The interval at which probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'LivenessProbe.TimeoutSeconds' => [ + 'description' => 'The timeout period for the probe. Unit: seconds. Default value: 1. Minimum value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Command' => [ + 'description' => 'The commands that you want to execute in the container when you use the command line interface (CLI) to perform probes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command.', + 'type' => 'string', + 'required' => false, + 'example' => 'sleep', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'SecurityContext.RunAsUser' => [ + 'description' => 'The ID of the user that runs the container.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'ReadinessProbe.HttpGet.Path' => [ + 'description' => 'The path to which HTTP GET requests are sent when you use HTTP requests to perform probes.', + 'type' => 'string', + 'required' => false, + 'example' => '/healthz', + ], + 'LivenessProbe.Exec.Command' => [ + 'description' => 'The command executed in the container when using the command line to perform the health check.', + 'type' => 'array', + 'items' => [ + 'description' => 'The command executed in the container when using the command line to perform the health check.', + 'type' => 'string', + 'required' => false, + 'example' => 'cat /tmp/healthy', + ], + 'required' => false, + 'maxItems' => 21, + ], + 'LifecyclePostStartHandlerHttpGetHost' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerHttpGetPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePostStartHandlerHttpGetPath' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerHttpGetScheme' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerExec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + 'LifecyclePostStartHandlerTcpSocketHost' => [ + 'type' => 'string', + ], + 'LifecyclePostStartHandlerTcpSocketPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePreStopHandlerHttpGetHost' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerHttpGetPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'LifecyclePreStopHandlerHttpGetPath' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerHttpGetScheme' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerExec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + 'LifecyclePreStopHandlerTcpSocketHost' => [ + 'type' => 'string', + ], + 'LifecyclePreStopHandlerTcpSocketPort' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the volumes.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the volumes.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of HostPathVolume. Examples: File, Directory, and Socket.', + 'type' => 'string', + 'required' => false, + 'example' => 'EmptyDirVolume', + ], + 'DiskVolume.DiskSize' => [ + 'description' => 'The storage size of the disk volume. Unit: GiB.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + 'NFSVolume.Path' => [ + 'description' => 'The path of the NFS volume.', + 'type' => 'string', + 'required' => false, + 'example' => '/share', + ], + 'FlexVolume.FsType' => [ + 'description' => 'The type of the mounted file system. By default, the value of this parameter varies based on the script of FlexVolume.', + 'type' => 'string', + 'required' => false, + 'example' => 'ext4', + ], + 'DiskVolume.FsType' => [ + 'description' => 'The type of the disk volume. We recommend that you specify the `FlexVolume.FsType` parameter instead of the DiskVolume.FsType parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'xfs', + ], + 'HostPathVolume.Type' => [ + 'description' => 'The type of host directory. For example: File, Directory, Socket, etc.', + 'type' => 'string', + 'required' => false, + 'example' => 'Directory', + ], + 'NFSVolume.ReadOnly' => [ + 'description' => 'Specifies whether the NFS volume is read-only.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'HostPathVolume.Path' => [ + 'description' => 'The absolute path to HostPathVolume.', + 'type' => 'string', + 'required' => false, + 'example' => '/xx/xx/name', + ], + 'FlexVolume.Options' => [ + 'description' => 'The FlexVolume objects. Each object is a key-value pair contained in a JSON string.'."\n" + ."\n" + .'For example, when you use FlexVolume to mount a disk, the format of objects is `{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}`.', + 'type' => 'string', + 'required' => false, + 'example' => '{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}', + ], + 'FlexVolume.Driver' => [ + 'description' => 'The name of the FlexVolume driver.', + 'type' => 'string', + 'required' => false, + 'example' => 'flexvolume', + ], + 'ConfigFileVolumeDefaultMode' => [ + 'description' => 'The default permissions on ConfigFileVolume.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0644', + ], + 'NFSVolume.Server' => [ + 'description' => 'The endpoint of the NFS server.', + 'type' => 'string', + 'required' => false, + 'example' => '3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com', + ], + 'DiskVolume.DiskId' => [ + 'description' => 'The ID of the disk volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'd-xx', + ], + 'Name' => [ + 'description' => 'The name of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'default-volume1', + ], + 'EmptyDirVolume.Medium' => [ + 'description' => 'The storage medium of EmptyDirVolume. If you leave this parameter empty, the file system that backs the node is used as the storage medium. If you set this parameter to memory, the memory is used as the storage medium.', + 'type' => 'string', + 'required' => false, + 'example' => 'memory', + ], + 'ConfigFileVolumeConfigFileToPath' => [ + 'description' => 'The paths to the configuration files.', + 'type' => 'array', + 'items' => [ + 'description' => 'The paths to the configuration files.', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The relative path to the configuration file.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/bin/', + ], + 'Mode' => [ + 'description' => 'The permissions on ConfigFileVolume.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0644', + ], + 'Content' => [ + 'description' => 'The content of the configuration file, which can be up to 32 KB in size.', + 'type' => 'string', + 'required' => false, + 'example' => 'bGl1bWk=', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 90, + ], + 'EmptyDirVolume.SizeLimit' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + ], + [ + 'name' => 'InitContainer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The init containers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The init containers.', + 'type' => 'object', + 'properties' => [ + 'InitContainerEnvironmentVar' => [ + 'description' => 'The environment variables of the init container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The environment variables of the init container.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the environment variable. The key must be 1 to 128 characters in length. Specify the name in the `[0-9a-zA-Z]` format. The name can contain underscores and cannot start with a digit.', + 'type' => 'string', + 'required' => false, + 'example' => 'Path', + ], + 'Value' => [ + 'description' => 'The value of the environment variable. The value must be 0 to 256 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/bin/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 301, + ], + 'SecurityContext.Capability.Add' => [ + 'description' => 'The permissions granted to processes in the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permission granted to processes in the container. Valid values: NET_ADMIN and NET_RAW.'."\n" + ."\n" + .'>To use NET_RAW, you must submit a ticket.', + 'type' => 'string', + 'required' => false, + 'example' => 'NET_ADMIN', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'Image' => [ + 'description' => 'The container image.', + 'type' => 'string', + 'required' => false, + 'example' => 'nginx', + ], + 'InitContainerVolumeMount' => [ + 'description' => 'Information about the volume mounts of the init container.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the volume mounts of the init container.', + 'type' => 'object', + 'properties' => [ + 'MountPropagation' => [ + 'description' => 'The mount propagation setting of the volume. Mount propagation allows the sharing of volumes that are mounted on one container with other containers in the same pod, or even with other pods on the same node. Valid values:'."\n" + ."\n" + .'- None: The volume mount does not receive subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'- HostToCotainer: The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories.'."\n" + .'- Bidirectional: This value is similar to HostToCotainer. The volume mount receives all subsequent mounts that are mounted to this volume or its subdirectories. In addition, all volume mounts that are created by the container are propagated back to the instance and to all containers of all pods that use the same volume.'."\n" + ."\n" + .'Default value: None.', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + ], + 'MountPath' => [ + 'description' => 'The path where the container mounts the volume.'."\n" + ."\n" + .'>Data stored in the path of the container is overwritten by the content of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/share/', + ], + 'ReadOnly' => [ + 'description' => 'Specifies whether the mount path is read-only.'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Name' => [ + 'description' => 'The name of the volume.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-empty', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume. The elastic container instance can mount different directories of the same volume to different subdirectories of containers.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/sub/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + 'ImagePullPolicy' => [ + 'description' => 'The image pulling policy. Valid values:'."\n" + ."\n" + .'* Always: Image pulling is always performed.'."\n" + .'* IfNotPresent: Image pulling is performed as needed. On-premises images are preferentially used. If no on-premises images are available, image pulling is performed.'."\n" + .'* Never: On-premises images are always used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Always', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs that you want to allocate to the container.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + 'WorkingDir' => [ + 'description' => 'The working directory.', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local', + ], + 'Command' => [ + 'description' => 'The commands that you want to run to start the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The commands that you want to run to start the container.', + 'type' => 'string', + 'required' => false, + 'example' => 'sleep', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'Arg' => [ + 'description' => 'The startup parameter of the container.', + 'type' => 'array', + 'items' => [ + 'description' => 'The arguments that are passed to the container startup command.', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'required' => false, + 'maxItems' => 101, + ], + 'SecurityContext.RunAsUser' => [ + 'description' => 'The ID of the user that runs the container.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '587', + ], + 'Gpu' => [ + 'description' => 'The number of GPUs that you want to allocate to the container.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The size of the memory. Unit: GiB.', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + 'Name' => [ + 'description' => 'The name of the container.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-init', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DnsConfigNameServer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IP addresses of the DNS servers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The IP addresses of the DNS servers.', + 'type' => 'string', + 'required' => false, + 'example' => '172.10.*.**', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'DnsConfigSearch', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The DNS lookup domains.', + 'type' => 'array', + 'items' => [ + 'description' => 'The DNS lookup domains.', + 'type' => 'string', + 'required' => false, + 'example' => 'svc.local.kubenetes', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'DnsConfigOption', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.', + 'type' => 'array', + 'items' => [ + 'description' => 'The objects. Each object is a name-value pair. The value is optional.', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The variable value of the security context in which the elastic container instance runs.', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + 'Name' => [ + 'description' => 'The variable value of the security context in which the elastic container instance runs.', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'HostAliase', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the hosts.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the hosts.', + 'type' => 'object', + 'properties' => [ + 'Ip' => [ + 'description' => 'The IP address that you want to add.', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + 'Hostname' => [ + 'description' => 'The name of the elastic container instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the elastic container instance.', + 'type' => 'string', + 'required' => false, + 'example' => '[\'hehe.com\', \'haha.com\']', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 101, + ], + ], + [ + 'name' => 'SecurityContextSysctl', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The system information of the security context in which the elastic container instance runs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The system information of the security context in which the elastic container instance runs.', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The hostnames that you want to add.', + 'type' => 'string', + 'required' => false, + 'example' => '65536', + ], + 'Name' => [ + 'description' => 'The hostnames that you want to add.', + 'type' => 'string', + 'required' => false, + 'example' => 'kernel.msgmax', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 11, + ], + ], + [ + 'name' => 'NtpServer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The domain names of the NTP server.', + 'type' => 'array', + 'items' => [ + 'description' => 'The domain names of the NTP server.', + 'type' => 'string', + 'required' => false, + 'example' => 'ntp.cloud.aliyuncs.com', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AcrRegistryInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Information about the Container Registry Enterprise Edition instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the Container Registry Enterprise Edition instance.', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => 'The domain names of the Container Registry Enterprise Edition instances. By default, all domain names of the Container Registry Enterprise Edition instances are displayed. You can specify one or more domain names. Separate multiple domain names with commas (,).', + 'type' => 'array', + 'items' => [ + 'description' => 'The domain names of the Container Registry Enterprise Edition instances. By default, all domain names of the Container Registry Enterprise Edition instances are displayed. You can specify one or more domain names. Separate multiple domain names with commas (,).', + 'type' => 'string', + 'required' => false, + 'example' => '*****-****-registry.cn-beijing.cr.aliyuncs.com', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'InstanceName' => [ + 'description' => 'The name of the Container Registry Enterprise Edition instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'acr-test', + ], + 'InstanceId' => [ + 'description' => 'The ID of the Container Registry Enterprise Edition instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-nwj395hgf6f3****', + ], + 'RegionId' => [ + 'description' => 'The region ID of the Container Registry Enterprise Edition instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'CostOptimization', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the cost optimization feature. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false'."\n" + ."\n" + .'Default value: false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InstanceFamilyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the instance type, which is used to filter the instance types that meet the specified criteria. This parameter takes effect only if you set the `CostOptimization` parameter to true. Valid values:'."\n" + ."\n" + .'* EntryLevel: shared instance type. Instances of this level are the most cost-effective but may not provide stable computing performance in a consistent manner. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see [Shared instance families](~~108489~~).'."\n" + .'* EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see [Instance family](~~25378~~).'."\n" + .'* CreditEntryLevel: This value is valid only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see the [Overview](~~59977~~) topic of burstable instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EnterpriseLevel', + ], + ], + [ + 'name' => 'ContainersUpdateType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The update mode of containers. Valid values:'."\n" + ."\n" + .'- RenewUpdate: full update mode. This value takes effect based on the value of the Containers parameters in an update request. This value indicates that the previous setting of the Containers parameter is overwritten.'."\n" + .'- IncrementalUpdate: incremental update mode. The value of the Containers parameter varies based on the value of the Containers.Name parameter. This value indicates that only the settings of the specified request parameters are updated.'."\n" + ."\n" + .'Default value: RenewUpdate.', + 'type' => 'string', + 'required' => false, + 'example' => 'RenewUpdate', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 10, + ], + ], + [ + 'name' => 'DataCacheBucket', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DataCachePL', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DataCacheProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'DataCacheBurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'GpuDriverVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Override', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '89945DD3-9072-47D0-A318-353284CF****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Forbidden.RiskControl', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"89945DD3-9072-47D0-A318-353284CF****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyEciScalingConfigurationResponse>\\n <RequestId>89945DD3-9072-47D0-A318-353284CF****</RequestId>\\n</ModifyEciScalingConfigurationResponse>","errorExample":""}]', + 'title' => 'ModifyEciScalingConfiguration', + 'description' => '## Description'."\n" + ."\n" + .'If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.'."\n", + ], + 'ScaleWithAdjustment' => [ + 'summary' => '基于指定调整规则触发性扩缩容', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92716', + 'abilityTreeNodes' => [ + 'FEATUREessSQIS9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-j6c1o397427hyjdc****', + ], + ], + [ + 'name' => 'AdjustmentType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies how to scale instances. Valid values:'."\n" + ."\n" + .'* QuantityChangeInCapacity: adds the specified number of ECS instances to or removes the specified number of ECS instances from the scaling group.'."\n" + .'* PercentChangeInCapacity: adds the specified percentage of ECS instances to or removes the specified percentage of ECS instances from the scaling group.'."\n" + .'* TotalCapacity: adjusts the number of ECS instances in the scaling group to the specified number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'QuantityChangeInCapacity', + ], + ], + [ + 'name' => 'AdjustmentValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of instances in each adjustment. The number of ECS instances in each adjustment cannot exceed 1,000.'."\n" + ."\n" + .'* Valid values if you set the AdjustmentType parameter to QuantityChangeInCapacity: -1000 to 1000.'."\n" + .'* Valid values if you set the AdjustmentType parameter to PercentChangeInCapacity: -100 to 10000.'."\n" + .'* Valid values if you set the AdjustmentType parameter to TotalCapacity: 0 to 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '-2147483648', + 'example' => '100', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'MinAdjustmentMagnitude', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of instances allowed in each adjustment. This parameter takes effect only if you set the `AdjustmentType` parameter to `PercentChangeInCapacity`.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'SyncActivity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to trigger the scaling activity in a synchronous manner. This parameter takes effect only on scaling groups for which you specified an expected number of instances. Valid values:'."\n" + ."\n" + .'* true: triggers the scaling activity in a synchronous manner. The scaling activity is triggered at the time when the scaling rule is executed.'."\n" + .'* false: does not trigger the scaling activity in a synchronous manner. After you change the expected number of instances for the scaling group, Auto Scaling checks whether the total number of instances in the scaling group matches the new expected number of instances and determines whether to trigger the scaling activity based on the check result.'."\n" + ."\n" + .'> For more information about the expected number of instances feature, see [Expected number of instances](~~146231~~).'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Overrides', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cpu' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'Memory' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'UserData' => [ + 'type' => 'string', + ], + 'ContainerOverride' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Memory' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'Arg' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Cpu' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'EnvironmentVar' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'type' => 'string', + ], + 'Key' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + [ + 'name' => 'LifecycleHookContext', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DisableLifecycleHook' => [ + 'type' => 'boolean', + ], + 'IgnoredLifecycleHookIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'LifecycleHookResult' => [ + 'type' => 'string', + ], + ], + ], + ], + [ + 'name' => 'ActivityMetadata', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ExecutionMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity.'."\n", + 'type' => 'string', + 'example' => 'asa-bp175o6f6ego3r2j****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'ActivityType' => [ + 'description' => 'The type of the scaling activity.'."\n" + ."\n" + .'If the `ActivityType` parameter is set to `CapacityChange`, only the expected number of instances is changed during the scaling activity that is specified by the `ScalingActivityId` parameter and no scale-out activity is triggered.'."\n" + ."\n" + .'This parameter takes effect only for scaling groups that have an expected number of instances.'."\n", + 'type' => 'string', + 'example' => 'CapacityChange', + ], + 'PlanResult' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceAllocations' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'type' => 'string', + ], + 'InstanceType' => [ + 'type' => 'string', + ], + 'SpotStrategy' => [ + 'type' => 'string', + ], + 'Amount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'InstanceChargeType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.Forbidden', + 'errorMessage' => 'Operation Forbidden', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp175o6f6ego3r2j****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ActivityType\\": \\"CapacityChange\\",\\n \\"PlanResult\\": {\\n \\"ResourceAllocations\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-g\\",\\n \\"InstanceType\\": \\"ecs.u1-c1m8.large\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"Amount\\": 1,\\n \\"InstanceChargeType\\": \\"Postpaid\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ScaleWithAdjustmentResponse>\\n <ScalingActivityId>asa-bp175o6f6ego3r2j****</ScalingActivityId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ActivityType>CapacityChange</ActivityType>\\n</ScaleWithAdjustmentResponse>","errorExample":""}]', + 'title' => 'ScaleWithAdjustment', + 'description' => '## Description'."\n" + ."\n" + .'Compared with the ExecuteScalingRule operation, the ScaleWithAdjustment operation does not require a scaling rule to be created in advance.'."\n" + ."\n" + .'Before you call the ScaleWithAdjustment operation, take note of the following items:'."\n" + ."\n" + .'* The following requirements must be met:'."\n" + ."\n" + .' * The scaling group is in the Active state.'."\n" + .' * No scaling activities in the scaling group are in progress.'."\n" + ."\n" + .'* If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.'."\n" + ."\n" + .'* If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.'."\n" + ."\n" + .'* If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.'."\n" + ."\n" + .'A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the `ScalingActivityId` parameter in the response.'."\n", + ], + 'ChangeResourceGroup' => [ + 'summary' => '更改伸缩组所属的资源组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163910', + 'abilityTreeNodes' => [ + 'FEATUREessXN6KX4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Only scaling groups are supported. Set the value to **scalinggroup**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'scalinggroup', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group for which you want to change the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp17xb4x1vr29lgt****', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which you want to add the scaling group.'."\n" + ."\n" + .'> You can use resource groups to manage resources owned by your Alibaba Cloud account. Resource groups simplify the resource and permission management of your Alibaba Cloud account. For more information, see [What is resource management?](~~94475~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aek2ckjqe3*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeResourceGroupResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ChangeResourceGroupResponse>","errorExample":""}]', + 'title' => 'ChangeResourceGroup', + 'description' => '## Description'."\n" + ."\n" + .'A resource is an entity of cloud services that you create on Alibaba Cloud. For example, a scaling group is a resource. A resource group is a collection of infrastructure for projects, environments, or stacks. In a resource group, you can manage resources, monitor resources, and perform operations in a centralized manner. This way, you do not need to view and check your Alibaba Cloud resources in each Alibaba Cloud service.'."\n", + ], + 'AttachServerGroups' => [ + 'summary' => '添加一个或多个负载均衡服务器组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166340', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests.'."\n" + ."\n" + .'The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure the idempotence of a request](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ForceAttach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to add the Elastic Compute Service (ECS) instances in the scaling group to the backend server group of the newly attached SLB instance. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'A collection of information about a load-balanced server group.', + 'type' => 'array', + 'items' => [ + 'description' => 'A collection of information about a load-balanced server group.', + 'type' => 'object', + 'properties' => [ + 'ServerGroupId' => [ + 'description' => 'The ID of backend server group N.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sgp-60ofsqhwer0b***', + ], + 'Type' => [ + 'description' => 'The type of backend server group N.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ALB'."\n" + .'* NLB'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ALB', + ], + 'Weight' => [ + 'description' => 'The weight of an ECS instance in the scaling group as a backend server after Auto Scaling adds the ECS instance to backend server group N. Valid values: 0 to 100.'."\n" + ."\n" + .'If you increase the weight of an ECS instance in a backend server group, the number of access requests that are forwarded to the ECS instance increases. If you set the **Weight** parameter for an ECS instance in a backend server group to **0**, no access requests are forwarded to the ECS instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'Port' => [ + 'description' => 'The port number used by an ECS instance in the scaling group after Auto Scaling adds the ECS instance to backend server group N. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity during which one or more SLB instances are attached to the scaling group and the ECS instances in the scaling group are added to the backend server groups of the SLB instances.'."\n" + ."\n" + .'> This parameter is returned only after you set the `ForceAttach` parameter to `true`.'."\n", + 'type' => 'string', + 'example' => 'asa-bp1c9djwrgxjyk31****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '74C4E313-8570-479F-8791-DC25360D****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp1c9djwrgxjyk31****\\",\\n \\"RequestId\\": \\"74C4E313-8570-479F-8791-DC25360D****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachServerGroupsResponse>\\n <ScalingActivityId>asa-bp1c9djwrgxjyk31****</ScalingActivityId>\\n <RequestId>74C4E313-8570-479F-8791-DC25360D****</RequestId>\\n</AttachServerGroupsResponse>","errorExample":""}]', + 'title' => 'AttachServerGroups', + 'description' => '## Debugging'."\n" + ."\n" + .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=Ess\\&api=AttachServerGroups\\&type=RPC\\&version=2014-08-28)'."\n", + ], + 'DetachServerGroups' => [ + 'summary' => '移除一个或多个负载均衡服务器组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166341', + 'abilityTreeNodes' => [ + 'FEATUREess2GK585', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scaling group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests.'."\n" + ."\n" + .'The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure the idempotence of a request](~~25965~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ForceDetach', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove the Elastic Compute Service (ECS) instances in the scaling group from the backend server group of the SLB instance that you want to detach from the scaling group. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ServerGroup', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Details of the server groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the server group.', + 'type' => 'object', + 'properties' => [ + 'ServerGroupId' => [ + 'description' => 'The ID of backend server group N.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sgp-1gv2uidn2msy****', + ], + 'Type' => [ + 'description' => 'The type of backend server group N. Valid values:'."\n" + ."\n" + .'* ALB'."\n" + .'* NLB'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ALB', + ], + 'Port' => [ + 'description' => 'The port number used by an ECS instance in the scaling group after Auto Scaling adds the ECS instance to backend server group N.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScalingActivityId' => [ + 'description' => 'The ID of the scaling activity during which one or more SLB instances are detached from the scaling group and the ECS instance in the scaling group are removed from the backend server groups of the SLB instances.'."\n" + ."\n" + .'> This parameter is returned only after you set the `ForceDetach` parameter to `true`.'."\n", + 'type' => 'string', + 'example' => 'asa-bp1gbswjhjrw8tko****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6EF9BFEE-FE07-4627-B8FB-14326FB9****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScalingActivityId\\": \\"asa-bp1gbswjhjrw8tko****\\",\\n \\"RequestId\\": \\"6EF9BFEE-FE07-4627-B8FB-14326FB9****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachServerGroupsResponse>\\n <ScalingActivityId>asa-bp1gbswjhjrw8tko****</ScalingActivityId>\\n <RequestId>6EF9BFEE-FE07-4627-B8FB-14326FB9****</RequestId>\\n</DetachServerGroupsResponse>","errorExample":""}]', + 'title' => 'DetachServerGroups', + ], + 'ModifyInstanceAttribute' => [ + 'summary' => '修改伸缩组内实例的部分信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201545', + 'abilityTreeNodes' => [ + 'FEATUREessBFHJ1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp109k5j3dum1ce6****', + ], + ], + [ + 'name' => 'Entrusted', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'docRequired' => true, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceAttributeResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyInstanceAttributeResponse>","errorExample":""}]', + 'title' => 'ModifyInstanceAttribute', + ], + 'DescribePatternTypes' => [ + 'summary' => 'DescribePatternTypes', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '222292', + 'abilityTreeNodes' => [ + 'FEATUREessWJGIW5', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'cn-hangzhou', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => 'vsw-bp14zolna43z266bq****', + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 100, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'NoSpot', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'Cores', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '4', + 'format' => 'float', + 'required' => false, + 'type' => 'number', + ], + ], + [ + 'name' => 'MaxPrice', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '2', + 'format' => 'float', + 'required' => false, + 'type' => 'number', + ], + ], + [ + 'name' => 'InstanceFamilyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'EnterpriseLevel', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ExcludedInstanceType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => 'ecs.c6.xlarge', + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 100, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => 'X86', + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 100, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'BurstablePerformance', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => 'Include', + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'CoresList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'MemoryList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '4', + 'format' => 'float', + 'required' => false, + 'type' => 'number', + ], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '79425074', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + ], + ], + [ + 'name' => 'InstanceTypeFamilies', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'MinimumCpuCoreCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MaximumCpuCoreCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'GpuSpecs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceCategories', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CpuArchitectures', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PhysicalProcessorModels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'MinimumEniQuantity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MinimumEniPrivateIpAddressQuantity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MinimumEniIpv6AddressQuantity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MinimumInitialCredit', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MinimumBaselineCredit', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MinimumMemorySize', + 'in' => 'query', + 'schema' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + [ + 'name' => 'MaximumMemorySize', + 'in' => 'query', + 'schema' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + [ + 'name' => 'MinimumGpuAmount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'MaximumGpuAmount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'PatternTypes' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'InstanceType' => [ + 'description' => '', + 'example' => 'ecs.c7.xlarge', + 'type' => 'string', + ], + 'InstanceFamilyLevel' => [ + 'description' => '', + 'example' => 'EnterpriseLevel', + 'type' => 'string', + ], + 'InstanceTypeFamily' => [ + 'description' => '', + 'example' => 'ecs.c7', + 'type' => 'string', + ], + 'Cores' => [ + 'description' => '', + 'example' => '4', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Memory' => [ + 'description' => '', + 'example' => '8', + 'format' => 'float', + 'type' => 'number', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"PatternTypes\\": [\\n {\\n \\"InstanceType\\": \\"ecs.c7.xlarge\\",\\n \\"InstanceFamilyLevel\\": \\"EnterpriseLevel\\",\\n \\"InstanceTypeFamily\\": \\"ecs.c7\\",\\n \\"Cores\\": 4,\\n \\"Memory\\": 8\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribePatternTypesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <PatternTypes>\\n <InstanceType>ecs.c7.xlarge</InstanceType>\\n <InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>\\n <InstanceTypeFamily>ecs.c7</InstanceTypeFamily>\\n <Cores>4</Cores>\\n <Memory>8</Memory>\\n </PatternTypes>\\n</DescribePatternTypesResponse>","errorExample":""}]', + 'title' => 'DescribePatternTypes', + ], + 'ApplyScalingGroup' => [ + 'summary' => '基于K8s Yaml格式配置应用弹性伸缩', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '206918', + 'abilityTreeNodes' => [ + 'FEATUREessGIWHSQ', + 'FEATUREessXN6KX4', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment labels: app: nginx spec: replicas: 3 selector: matchLabels: app: nginx template: metadata: labels: app: nginx annotations: k8s.aliyun.com/eip-bandwidth: 10 k8s.aliyun.com/eci-with-eip: true spec: containers: - name: nginx image: nginx:1.14.2 ports: - containerPort: 80', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'CC107349-57B7-4405-B1BF-9BF5AF7F****', + ], + 'ScalingGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CC107349-57B7-4405-B1BF-9BF5AF7F****\\",\\n \\"ScalingGroupId\\": \\"asg-bp1igpak5ft1flyp****\\"\\n}","errorExample":""},{"type":"xml","example":"<ApplyScalingGroupResponse>\\n <RequestId>CC107349-57B7-4405-B1BF-9BF5AF7F****</RequestId>\\n <ScalingGroupId>asg-bp1igpak5ft1flyp****</ScalingGroupId>\\n</ApplyScalingGroupResponse>","errorExample":""}]', + 'title' => 'ApplyScalingGroup', + ], + 'ModifyAlertConfiguration' => [ + 'summary' => '设置伸缩组中需要发送消息通知的伸缩活动状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '208787', + 'abilityTreeNodes' => [ + 'FEATUREessLTO4TI', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1eyv4qn8ssgv43****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScaleStatus', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ScaleSuccessful', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '73469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAlertConfigurationResponse>\\n <RequestId>73469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ModifyAlertConfigurationResponse>","errorExample":""}]', + 'title' => 'ModifyAlertConfiguration', + ], + 'DescribeAlertConfiguration' => [ + 'summary' => '查询伸缩组中需要发送消息的伸缩活动状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '208803', + 'abilityTreeNodes' => [ + 'FEATUREessFY8KDA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'ScaleStatuses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ScaleStatus' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ScaleSuccessful', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"ScaleStatuses\\": {\\n \\"ScaleStatus\\": [\\n \\"ScaleSuccessful\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertConfigurationResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <ScaleStatuses>ScaleSuccessful</ScaleStatuses>\\n</DescribeAlertConfigurationResponse>","errorExample":""}]', + 'title' => ' DescribeAlertConfiguration', + ], + 'SuspendInstanceRefresh' => [ + 'summary' => '暂停实例刷新任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '232222', + 'abilityTreeNodes' => [ + 'FEATUREessPV8ZVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'InstanceRefreshTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ir-a12ds234fasd*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<SuspendInstanceRefreshResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</SuspendInstanceRefreshResponse>","errorExample":""}]', + 'title' => 'SuspendInstanceRefresh', + ], + 'ResumeInstanceRefresh' => [ + 'summary' => '恢复暂停中的实例刷新任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '232223', + 'abilityTreeNodes' => [ + 'FEATUREessPV8ZVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'InstanceRefreshTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ir-a12ds234fasd*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeInstanceRefreshResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</ResumeInstanceRefreshResponse>","errorExample":""}]', + 'title' => 'ResumeInstanceRefresh', + ], + 'CancelInstanceRefresh' => [ + 'summary' => '取消实例刷新任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '232214', + 'abilityTreeNodes' => [ + 'FEATUREessPV8ZVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp1igpak5ft1flyp****', + ], + ], + [ + 'name' => 'InstanceRefreshTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ir-aca123sf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelInstanceRefreshResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n</CancelInstanceRefreshResponse>","errorExample":""}]', + 'title' => 'CancelInstanceRefresh', + ], + 'DescribeInstanceRefreshes' => [ + 'summary' => '查询实例刷新任务列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232225', + 'abilityTreeNodes' => [ + 'FEATUREessACRSW1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'asg-bp1ffogfdauy0jw0****', + ], + ], + [ + 'name' => 'InstanceRefreshTaskId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ir-adfa12312*****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f****', + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceRefreshTasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceRefreshTask' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceRefreshTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ir-1adfa123****', + ], + 'ScalingGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'asg-bp16pbfcr8j9*****', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-22T02:09:00Z', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-22T01:09:00Z', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InProgress', + ], + 'Detail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The task exceeded its maximum run time of one week. So the task failed.', + ], + 'MinHealthyPercentage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'MaxHealthyPercentage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'DesiredConfiguration' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'm-uf6g5noisr****', + ], + 'ScalingConfigurationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'asc-wz91ibkhfor****', + ], + 'LaunchTemplateId' => [ + 'type' => 'string', + ], + 'LaunchTemplateVersion' => [ + 'type' => 'string', + ], + 'LaunchTemplateOverrides' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LaunchTemplateOverride' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Containers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Container' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + ], + 'Image' => [ + 'type' => 'string', + ], + 'Commands' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Command' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'EnvironmentVars' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EnvironmentVar' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + 'FieldRefFieldPath' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Args' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Arg' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'FinishedUpdateCapacity' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalNeedUpdateCapacity' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SkipMatching' => [ + 'type' => 'boolean', + ], + 'CheckpointPauseTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Checkpoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Checkpoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f****\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": 100,\\n \\"InstanceRefreshTasks\\": {\\n \\"InstanceRefreshTask\\": [\\n {\\n \\"InstanceRefreshTaskId\\": \\"ir-1adfa123****\\",\\n \\"ScalingGroupId\\": \\"asg-bp16pbfcr8j9*****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EndTime\\": \\"2024-08-22T02:09:00Z\\",\\n \\"StartTime\\": \\"2024-08-22T01:09:00Z\\",\\n \\"Status\\": \\"InProgress\\",\\n \\"Detail\\": \\"The task exceeded its maximum run time of one week. So the task failed.\\",\\n \\"MinHealthyPercentage\\": 80,\\n \\"MaxHealthyPercentage\\": 120,\\n \\"DesiredConfiguration\\": {\\n \\"ImageId\\": \\"m-uf6g5noisr****\\",\\n \\"ScalingConfigurationId\\": \\"asc-wz91ibkhfor****\\",\\n \\"LaunchTemplateId\\": \\"lt-2ze5x4mp*****\\",\\n \\"LaunchTemplateVersion\\": \\"Latest\\",\\n \\"LaunchTemplateOverrides\\": {\\n \\"LaunchTemplateOverride\\": [\\n {\\n \\"InstanceType\\": \\"ecs.g7.2xlarge\\"\\n }\\n ]\\n },\\n \\"Containers\\": {\\n \\"Container\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Image\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest\\",\\n \\"Commands\\": {\\n \\"Command\\": [\\n \\"sleep\\"\\n ]\\n },\\n \\"EnvironmentVars\\": {\\n \\"EnvironmentVar\\": [\\n {\\n \\"Key\\": \\"PATH\\",\\n \\"Value\\": \\"/usr/local/bin\\",\\n \\"FieldRefFieldPath\\": \\"fieldPath\\"\\n }\\n ]\\n },\\n \\"Args\\": {\\n \\"Arg\\": [\\n \\"100\\"\\n ]\\n }\\n }\\n ]\\n }\\n },\\n \\"FinishedUpdateCapacity\\": 10,\\n \\"TotalNeedUpdateCapacity\\": 20,\\n \\"SkipMatching\\": true,\\n \\"CheckpointPauseTime\\": 30,\\n \\"Checkpoints\\": {\\n \\"Checkpoint\\": [\\n {\\n \\"Percentage\\": 60\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceRefreshesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <NextToken>caeba0bbb2be03f84eb48b699f****</NextToken>\\n <MaxResults>50</MaxResults>\\n <TotalCount>100</TotalCount>\\n <InstanceRefreshTasks>\\n <InstanceRefreshTaskId>ir-1adfa123****</InstanceRefreshTaskId>\\n <ScalingGroupId>asg-bp16pbfcr8j9*****</ScalingGroupId>\\n <RegionId>cn-hangzhou</RegionId>\\n <EndTime>2024-08-22T02:09:00Z</EndTime>\\n <StartTime>2024-08-22T01:09:00Z</StartTime>\\n <Status>InProgress</Status>\\n <Detail>The task exceeded its maximum run time of one week. So the task failed.</Detail>\\n <MinHealthyPercentage>80</MinHealthyPercentage>\\n <MaxHealthyPercentage>120</MaxHealthyPercentage>\\n <DesiredConfiguration>\\n <ImageId>m-uf6g5noisr****</ImageId>\\n <ScalingConfigurationId>asc-wz91ibkhfor****</ScalingConfigurationId>\\n </DesiredConfiguration>\\n <FinishedUpdateCapacity>10</FinishedUpdateCapacity>\\n <TotalNeedUpdateCapacity>20</TotalNeedUpdateCapacity>\\n </InstanceRefreshTasks>\\n</DescribeInstanceRefreshesResponse>","errorExample":""}]', + 'title' => 'DescribeInstanceRefreshes', + ], + 'RollbackInstanceRefresh' => [ + 'summary' => '回滚实例刷新任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '232220', + 'abilityTreeNodes' => [ + 'FEATUREessPV8ZVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'InstanceRefreshTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ir-a12ds234fasd*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B13527BF-1FBD-4334-A512-20F5E9D3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B13527BF-1FBD-4334-A512-20F5E9D3****\\"\\n}","errorExample":""},{"type":"xml","example":"<RollbackInstanceRefreshResponse>\\n <RequestId>B13527BF-1FBD-4334-A512-20F5E9D3****</RequestId>\\n</RollbackInstanceRefreshResponse>","errorExample":""}]', + 'title' => 'RollbackInstanceRefresh', + ], + 'StartInstanceRefresh' => [ + 'summary' => '启动实例刷新任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232212', + 'abilityTreeNodes' => [ + 'FEATUREessPV8ZVU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + [ + 'name' => 'ScalingGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'asg-bp18p2yfxow2dloq****', + ], + ], + [ + 'name' => 'MinHealthyPercentage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'MaxHealthyPercentage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'DesiredConfiguration', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'm-2ze8cqacj7opnf***', + ], + 'ScalingConfigurationId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'asc-2zed7lqn4ts4****', + ], + 'LaunchTemplateId' => [ + 'type' => 'string', + ], + 'LaunchTemplateVersion' => [ + 'type' => 'string', + ], + 'LaunchTemplateOverrides' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Containers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + ], + 'Image' => [ + 'type' => 'string', + ], + 'Commands' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Args' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'EnvironmentVars' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + 'FieldRefFieldPath' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SkipMatching', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Checkpoints', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CheckpointPauseTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + 'InstanceRefreshTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ir-a12ds234fasd*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"InstanceRefreshTaskId\\": \\"ir-a12ds234fasd*****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartInstanceRefreshResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <InstanceRefreshTaskId>ir-a12ds234fasd*****</InstanceRefreshTaskId>\\n</StartInstanceRefreshResponse>","errorExample":""}]', + 'title' => 'StartInstanceRefresh', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ess.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'ess.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'ess.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ess.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'ess.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'ess.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'ess.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ess.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'ess.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ess.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ess.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'ess.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ess.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'ess.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ess.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ess.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'ess.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'ess.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ess.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ess.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ess.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'ess.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'ess.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'ess.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'ess.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'ess.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'ess.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'ess.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu-gic-1', + 'endpoint' => 'ess.cn-wulanchabu-gic-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'ess.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'ess.cn-zhongwei.aliyuncs.com', + ], + ], +]; |