Contents:
- Activity
- ActivtyRelatedInstance
- AutoScalingGroup
- AutoScalingGroupAbstract
- AutoScalingNotification
- DataDisk
- EnhancedService
- Filter
- ForwardLoadBalancer
- HostNameSettings
- Instance
- InstanceChargePrepaid
- InstanceMarketOptionsRequest
- InstanceTag
- InternetAccessible
- LaunchConfiguration
- LifecycleHook
- LimitedLoginSettings
- LoginSettings
- MetricAlarm
- NotificationTarget
- PaiInstance
- RunMonitorServiceEnabled
- RunSecurityServiceEnabled
- ScalingPolicy
- ScheduledAction
- ServiceSettings
- SpotMarketOptions
- SystemDisk
- Tag
- TargetAttribute
Activity
Information on eligible scaling activities.
Used by actions: DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
ActivityId | String | Scaling activity ID. |
ActivityType | String | Scaling activity type. Value range: |
StatusCode | String | Scaling activity status. Value range: |
StatusMessage | String | Description of the scaling activity status. |
Cause | String | Cause of the scaling activity. |
Description | String | Description of the scaling activity. |
StartTime | Timestamp | Start time of the scaling activity. |
EndTime | Timestamp | End time of the scaling activity. |
CreatedTime | Timestamp | Creation time of the scaling activity. |
ActivityRelatedInstanceSet | Array of ActivtyRelatedInstance | Information set of the instances related to the scaling activity. |
StatusMessageSimplified | String | Brief description of the scaling activity status. |
ActivtyRelatedInstance
Information of the instances related to the current scaling activity.
Used by actions: DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. |
InstanceStatus | String | Status of the instance in the scaling activity. Value range: |
AutoScalingGroup
Auto scaling group
Used by actions: DescribeAutoScalingGroups.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID |
AutoScalingGroupName | String | Auto scaling group name |
AutoScalingGroupStatus | String | Current status of the auto scaling group. Value range: |
CreatedTime | Timestamp | Creation time in UTC format |
DefaultCooldown | Integer | Default cooldown period in seconds |
DesiredCapacity | Integer | Desired number of instances |
EnabledStatus | String | Enabled status. Value range: ENABLED , DISABLED |
ForwardLoadBalancerSet | Array of ForwardLoadBalancer | List of application load balancers |
InstanceCount | Integer | Number of instances |
InServiceInstanceCount | Integer | Number of instances in IN_SERVICE status |
LaunchConfigurationId | String | Launch configuration ID |
LaunchConfigurationName | String | Launch configuration name |
LoadBalancerIdSet | Array of String | List of Classic load balancer IDs |
MaxSize | Integer | Maximum number of instances |
MinSize | Integer | Minimum number of instances |
ProjectId | Integer | Project ID |
SubnetIdSet | Array of String | List of subnet IDs |
TerminationPolicySet | Array of String | Termination policy |
VpcId | String | VPC ID |
ZoneSet | Array of String | List of availability zones |
RetryPolicy | String | Retry policy |
InActivityStatus | String | Whether the auto scaling group is performing a scaling activity. IN_ACTIVITY indicates yes, and NOT_IN_ACTIVITY indicates no. |
Tags | Array of Tag | List of auto scaling group tags |
ServiceSettings | ServiceSettings | Service settings |
Ipv6AddressCount | Integer |
AutoScalingGroupAbstract
Brief information of an auto scaling group.
Used by actions: DescribeLaunchConfigurations.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
AutoScalingGroupName | String | Auto scaling group name. |
AutoScalingNotification
AS event notification
Used by actions: DescribeNotificationConfigurations.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
NotificationUserGroupIds | Array of String | List of user group IDs. |
NotificationTypes | Array of String | List of notification events. |
AutoScalingNotificationId | String | Event notification ID. |
DataDisk
Configuration information of data disk in launch configuration. If this parameter is not specified, no data disk will be purchased by default. You can specify only one data disk when purchasing it.
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | No | Data disk type. For more information on limits of data disk types, see CVM Instance Configuration. Value range: Default value: LOCAL_BASIC. Note: This field may return null, indicating that no valid values can be obtained. |
DiskSize | Integer | No | Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation. Note: This field may return null, indicating that no valid values can be obtained. |
SnapshotId | String | No | Data disk snapshot ID, such as snap-l8psqwnt .Note: This field may return null, indicating that no valid values can be obtained. |
EnhancedService
This describes the conditions of enhancement services for the instance and their settings, such as the Agent of Cloud Security or Cloud Monitor.
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
SecurityService | RunSecurityServiceEnabled | No | Enables the Cloud Security service. If this parameter is not specified, the Cloud Security service will be enabled by default. |
MonitorService | RunMonitorServiceEnabled | No | Enables the Cloud Monitor service. If this parameter is not specified, the Cloud Monitor service will be enabled by default. |
Filter
Key-value pair filters for conditional filtering queries, such as filtering ID, name, status, etc.
- If there are multiple
Filter
, the relationship among them is logicalAND
.- If there are multiple
Values
in the sameFilter
, the relationship among theValues
in the sameFilter
is logicalOR
.Take the
Filter
in the API DescribeInstances as an example. We can use the following filters to query the instance that resides in the availability zone (zone
) of Guangzhou Zone 1 and is billed (instance-charge-type
) on a prepaid basis or on a pay-as-you-go basis:
Filters.0.Name=zone
&Filters.0.Values.1=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.1=PREPAID
&Filters.1.Values.2=POSTPAID_BY_HOUR
Used by actions: DescribeAutoScalingActivities、DescribeAutoScalingGroups、DescribeAutoScalingInstances、DescribeLaunchConfigurations、DescribeLifecycleHooks、DescribeNotificationConfigurations、DescribePaiInstances、DescribeScalingPolicies、DescribeScheduledActions.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Field to be filtered. |
Values | Array of String | Yes | Filter value of the field. |
ForwardLoadBalancer
Application load balancer
Used by actions: CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyLoadBalancers.
Name | Type | Required | Description |
---|---|---|---|
LoadBalancerId | String | Yes | Load balancer ID |
ListenerId | String | Yes | Application load balancer listener ID |
TargetAttributes | Array of TargetAttribute | Yes | List of target rule attributes |
LocationId | String | No | ID of a forwarding rule. This parameter is required for layer-7 listeners. |
HostNameSettings
CVM HostName settings
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
HostName | String | Yes | Host name of a CVM. Note: This field may return null, indicating that no valid values can be obtained. |
HostNameStyle | String | No | Type of CVM host name. Valid values: "ORIGINAL" and "UNIQUE". Default value: "ORIGINAL" Note: This field may return null, indicating that no valid values can be obtained. |
Instance
Instance information
Used by actions: DescribeAutoScalingInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
AutoScalingGroupId | String | Auto scaling group ID |
LaunchConfigurationId | String | Launch configuration ID |
LaunchConfigurationName | String | Launch configuration name |
LifeCycleState | String | Lifecycle status. Value range: IN_SERVICE, CREATING, TERMINATING, ATTACHING, DETACHING, ATTACHING_LB, DETACHING_LB |
HealthStatus | String | Health status. Value range: HEALTHY, UNHEALTHY |
ProtectedFromScaleIn | Boolean | Whether to add scale-in protection |
Zone | String | Availability zone |
CreationType | String | Creation type. Value range: AUTO_CREATION, MANUAL_ATTACHING. |
AddTime | Timestamp | Instance addition time |
InstanceType | String | Instance type |
VersionNumber | Integer | Version number |
AutoScalingGroupName | String | Auto scaling group name |
InstanceChargePrepaid
This describes the billing method of an instance
Used by actions: CreatePaiInstance.
Name | Type | Required | Description |
---|---|---|---|
Period | Integer | Yes | Purchased usage period of an instance in months. Value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. |
RenewFlag | String | No | Auto-renewal flag. Value range: Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. |
InstanceMarketOptionsRequest
Options related to a CVM bidding request
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
SpotOptions | SpotMarketOptions | Yes | Bidding-related options |
MarketType | String | No | Market option type. Currently, this only supports the value "spot" Note: This field may return null, indicating that no valid values can be obtained. |
InstanceTag
Instance tag. This parameter is used to bind tags to newly added instances.
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Tag key |
Value | String | Yes | Tag value |
InternetAccessible
This describes the internet accessibility of the instance created by a launch configuration and declares the internet usage billing method of the instance and the maximum bandwidth
Used by actions: CreateLaunchConfiguration、CreatePaiInstance、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
InternetChargeType | String | No | Network billing method. Value range: Default value: TRAFFIC_POSTPAID_BY_HOUR. Note: This field may return null, indicating that no valid values can be obtained. |
InternetMaxBandwidthOut | Integer | No | The maximum outbound bandwidth in Mbps of the public network. The default value is 0 Mbps. The upper limit of bandwidth varies by model. For more information, see Purchase Network Bandwidth. Note: This field may return null, indicating that no valid values can be obtained. |
PublicIpAssigned | Boolean | No | Whether to assign a public IP. Value range: If the public network bandwidth is greater than 0 Mbps, you are free to choose whether to enable the public IP (which is enabled by default). If the public network bandwidth is 0 Mbps, no public IP will be allowed to be assigned. Note: This field may return null, indicating that no valid values can be obtained. |
LaunchConfiguration
Information set of eligible launch configurations.
Used by actions: DescribeLaunchConfigurations.
Name | Type | Description |
---|---|---|
ProjectId | Integer | Project ID of the instance. |
LaunchConfigurationId | String | Launch configuration ID. |
LaunchConfigurationName | String | Launch configuration name. |
InstanceType | String | Instance model. |
SystemDisk | SystemDisk | Information of the instance's system disk configuration. |
DataDisks | Array of DataDisk | Information of the instance's data disk configuration. |
LoginSettings | LimitedLoginSettings | Instance login settings. |
InternetAccessible | InternetAccessible | Information of the public network bandwidth configuration. |
SecurityGroupIds | Array of String | Security group of the instance. |
AutoScalingGroupAbstractSet | Array of AutoScalingGroupAbstract | Auto scaling group associated with the launch configuration. |
UserData | String | Custom data. Note: This field may return null, indicating that no valid values can be obtained. |
CreatedTime | Timestamp | Creation time of the launch configuration. |
EnhancedService | EnhancedService | Conditions of enhancement services for the instance and their settings. |
ImageId | String | Image ID. |
LaunchConfigurationStatus | String | Current status of the launch configuration. Value range: |
InstanceChargeType | String | Instance billing type. CVM instances are POSTPAID_BY_HOUR by default. |
InstanceMarketOptions | InstanceMarketOptionsRequest | Market-related options of the instance, such as the parameters related to stop instances. If the billing method of instance is specified as bidding, this parameter must be passed in. Note: This field may return null, indicating that no valid values can be obtained. |
InstanceTypes | Array of String | List of instance models. |
InstanceTags | Array of InstanceTag | List of tags. |
VersionNumber | Integer | Version number. |
UpdatedTime | Timestamp | Update time. |
CamRoleName | String | CAM role name, which can be obtained from the roleName field in the return value of the DescribeRoleList API. |
LastOperationInstanceTypesCheckPolicy | String | Value of InstanceTypesCheckPolicy upon the last operation. |
HostNameSettings | HostNameSettings | CVM HostName settings. |
LifecycleHook
Lifecycle hook
Used by actions: DescribeLifecycleHooks.
Name | Type | Description |
---|---|---|
LifecycleHookId | String | Lifecycle hook ID |
LifecycleHookName | String | Lifecycle hook name |
AutoScalingGroupId | String | Auto scaling group ID |
DefaultResult | String | Default result of the lifecycle hook |
HeartbeatTimeout | Integer | Wait timeout period of the lifecycle hook |
LifecycleTransition | String | Applicable scenario of the lifecycle hook |
NotificationMetadata | String | Additional information for the notification target |
CreatedTime | Timestamp | Creation time |
NotificationTarget | NotificationTarget | Notification target |
LimitedLoginSettings
This describes the configuration and information related to instance login. For security reasons, sensitive information is not described.
Used by actions: DescribeLaunchConfigurations.
Name | Type | Description |
---|---|---|
KeyIds | Array of String | List of key IDs. |
LoginSettings
This describes the configuration and information related to instance login.
Used by actions: CreateLaunchConfiguration、CreatePaiInstance、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Password | String | No | Login password of the instance. The rule of password complexity varies by operating system: ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]. <br><li>For Windows instances, the password must be a combination of 12-16 characters comprised of at least three of the following types: [a-z], [A-Z], [0-9] and [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]. If this parameter is not specified, a password will be randomly generated and sent to you via internal message. Note: This field may return null, indicating that no valid values can be obtained. |
KeyIds | Array of String | No | List of key IDs. An instance associated with the key can be accessed using the corresponding private key. KeyId can be obtained via the API DescribeKeyPairs. A key and a password cannot be specified at the same time, and specifying the key is not supported in Windows. You can specify only one key when purchasing an instance. |
KeepImageLogin | Boolean | No | Keep the original settings for an image. You cannot specify this parameter if Password or KeyIds.N is specified. You can specify this parameter to TRUE only when you create an instance using a custom image, shared image, or image imported from external resources. Value range: Default value: FALSE. Note: This field may return null, indicating that no valid values can be obtained. |
MetricAlarm
Alarming metric of AS
Used by actions: CreateScalingPolicy、DescribeScalingPolicies、ModifyScalingPolicy.
Name | Type | Required | Description |
---|---|---|---|
ComparisonOperator | String | Yes | Comparison operator. Value range: |
MetricName | String | Yes | Metric name. Value range: |
Threshold | Integer | Yes | Alarming threshold: |
Period | Integer | Yes | Time period in seconds. Enumerated values: 60, 300. |
ContinuousTime | Integer | Yes | Number of repetitions. Value range: [1, 10] |
Statistic | String | No | Statistics type. Value range: Default value: AVERAGE |
NotificationTarget
Notification target
Used by actions: CreateLifecycleHook、DescribeLifecycleHooks、UpgradeLifecycleHook.
Name | Type | Required | Description |
---|---|---|---|
TargetType | String | Yes | Target type. Value range: CMQ_QUEUE , CMQ_TOPIC . |
QueueName | String | No | Queue name. If TargetType is CMQ_QUEUE , this parameter is required. |
TopicName | String | No | Topic name. If TargetType is CMQ_TOPIC , this parameter is required. |
PaiInstance
PAI instance
Used by actions: DescribePaiInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
DomainName | String | Instance domain name |
PaiMateUrl | String |
RunMonitorServiceEnabled
This describes the information related to the Cloud Monitor service.
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Enabled | Boolean | No | Whether to enable the Cloud Monitor service. Value range: Default value: TRUE. | Note: This field may return null, indicating that no valid values can be obtained. |
RunSecurityServiceEnabled
This describes the information on the Cloud Security service
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Enabled | Boolean | No | Whether to enable the Cloud Security service. Value range: Default value: TRUE. Note: This field may return null, indicating that no valid values can be obtained. |
ScalingPolicy
Alarm trigger policy.
Used by actions: DescribeScalingPolicies.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
AutoScalingPolicyId | String | Alarm trigger policy ID. |
ScalingPolicyName | String | Alarm trigger policy name. |
AdjustmentType | String | The method to adjust the desired number of instances after the alarm is triggered. Value range: |
AdjustmentValue | Integer | The adjusted value of desired number of instances after the alarm is triggered. |
Cooldown | Integer | Cooldown period. |
MetricAlarm | MetricAlarm | Alarm monitoring metric. |
NotificationUserGroupIds | Array of String | Notification group ID, which is the set of user group IDs. |
ScheduledAction
This describes the information of a scheduled task.
Used by actions: DescribeScheduledActions.
Name | Type | Description |
---|---|---|
ScheduledActionId | String | Scheduled task ID. |
ScheduledActionName | String | Scheduled task name. |
AutoScalingGroupId | String | ID of the auto scaling group where the scheduled task is located. |
StartTime | Timestamp | Start time of the scheduled task. The value is in Beijing time (UTC+8) in the format of YYYY-MM-DDThh:mm:ss+08:00 according to the ISO8601 standard. |
Recurrence | String | Repeating mode of the scheduled task. |
EndTime | Timestamp | End time of the scheduled task. The value is in Beijing time (UTC+8) in the format of YYYY-MM-DDThh:mm:ss+08:00 according to the ISO8601 standard. |
MaxSize | Integer | Maximum number of instances set by the scheduled task. |
DesiredCapacity | Integer | Desired number of instances set by the scheduled task. |
MinSize | Integer | Minimum number of instances set by the scheduled task. |
CreatedTime | Timestamp | Creation time of the scheduled task. The value is in UTC time in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard. |
ServiceSettings
Service settings
Used by actions: CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyAutoScalingGroup.
Name | Type | Required | Description |
---|---|---|---|
ReplaceMonitorUnhealthy | Boolean | No | Enables unhealthy instance replacement. If this feature is enabled, AS will replace instances that are flagged as unhealthy by Cloud Monitor. If this parameter is not specified, the value will be False by default. |
SpotMarketOptions
Bidding-related options
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
MaxPrice | String | Yes | Bidding price such as "1.05" |
SpotInstanceType | String | No | Bid request type. Currently, only "one-time" type is supported. Default value: one-time Note: This field may return null, indicating that no valid values can be obtained. |
SystemDisk
System disk configuration of the launch configuration. If this parameter is not specified, the default value is assigned to it.
Used by actions: CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | No | System disk type. For more information on limits of system disk types, see CVM Instance Configuration. Value range: Default value: LOCAL_BASIC. Note: This field may return null, indicating that no valid values can be obtained. |
DiskSize | Integer | No | System disk size in GB. Default value: 50 Note: This field may return null, indicating that no valid values can be obtained. |
Tag
Resource type and tag key-value pair
Used by actions: CreateAutoScalingGroup、DescribeAutoScalingGroups.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Tag key |
Value | String | Yes | Tag value |
ResourceType | String | No | Type of the resource binded to the tag. Currently supported types include "auto-scaling-group" Note: This field may return null, indicating that no valid values can be obtained. |
TargetAttribute
Load balancer target attribute
Used by actions: CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyLoadBalancers.
Name | Type | Required | Description |
---|---|---|---|
Port | Integer | Yes | Port |
Weight | Integer | Yes | Weight |