Describe Servers

Operation Name

Describe Servers

Function overview

Obtains the status of launched Amazon EC2 instances.

Properties

For information about using variables, refer to "variables".
Basic settings
Item name Required/Optional Use of Variables Description Remarks
Name Required Not available Enter the name on the script canvas.  
Required settings
Item name Required/Optional Use of Variables Description Remarks
Connect To Required Not available Select Global Resources.
  • [Add]:
    Adds new global resource.
  • [Edit list]:
    Global resource settings can be edited with "Edit Resource list".
 
Comment
Item name Required/Optional Use of Variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.
 

Schema

Input Schema

None.

Output Schema

<?xml version="1.0"?>
<instances>
  <instance amiLaunchIndex="" architecture="" availabilityZone="" image="" instanceId="" instanceName="" instanceState=""
  instanceType="" kernelId="" keyPairName="" launchTime="" monitoringState="" ownerId="" privateDnsName="" privateIpAddress=""
  publicDnsName="" publicIpAddress="" ramDiskId="" reservationId="" rootDevice="" rootDeviceType="" spotInstanceRequestId=""
  stateTransitionReason="" subnetId="" tenancy="" virtualizationType="" vpcId="">
    <tags>
      <tag key="" value="" />
    </tags>
    <securityGroups>
      <securityGroup id="" name="" />
    </securityGroups>
  </instance>
</instances>
Element Name Attribute Name Description Supplement
instances      
instance   Element occurs for every instance.  
amiLaunchIndex Returns the AMI Launch Index.  
architecture Returns the instance architecture.  
availabilityZone Returns the Availability Zone in which the instance exists.  
image Returns the Amazon Machine Image(AMI). Should the name of the Amazon Machine Image(AMI) cannot be obtained, the value becomes empty.
instanceId Returns the instance ID.  
instanceName Returns the Name Tag value.  
instanceState Returns the instance status.
  • [running]:Instance is launched.
  • [pending]:Instance is in the process of being launched.
  • [stopping]:Instance is in the process of being stopped.
  • [stopped]:Instance is stopped.
  • [shutting-down]:Instance started shutting down.
  • [terminated]:Instance is terminated.
 
instanceType Returns the instance type.
  • [t1.micro]:Micro On-Demand instance/Micro
  • [m1.small]:Standard On-Demand instance /Small
  • [m1.large]:Standard On-Demand instance/Large
  • [m1.xlarge]:Standard On-Demand instance/Extra Large
  • [m2.xlarge]:High-Memory On-Demand instance/Extra Large
  • [m2.2xlarge]:High-Memory On-Demand instance/Double Extra Large
  • [m2.4xlarge]:High-Memory On-Demand instance/Quadruple Extra Large
  • [c1.medium]:High-CPU On-Demand instance/Medium
  • [c1.xlarge]:High-CPU On-Demand instance/Extra Large
  • [cc1.4xlarge]:Cluster Compute instance/Quadruple Extra Large
  • [cg1.4xlarge]:Cluster GPU instance/Quadruple Extra Large
 
kernelId Returns Kernel ID.  
keyPairName Returns the key pair name that is required when logging into the instance.  
launchTime Returns the most recent date time instance was launched. Date time is parsed and formatted to the date format style configured in DataSpider setting. For more details about the date format style, refer to 'Data types'.
monitoringState Returns the monitoring state.
  • [enabled]:Instance monitoring is enabled.
  • [disabled]:Instance monitoring is disabled.
  • [pending]:Instance monitoring is in the process of being monitored.
 
ownerId Returns the Amazon Machine Image(AMI) owner ID.  
privateDnsName Returns Private DNS of the instance.  
privateIpAddress Returns Private IP address of the instance.  
publicDnsName Returns Public DNS name of the instance.  
publicIpAddress Returns Public IP address of the instance.  
ramDiskId Returns RAM Disk ID.  
reservationId Returns Reservation ID.  
rootDevice Returns Root Device name.  
rootDeviceType Returns Root Device type.
  • [ebs]:EBS type.
  • [instance-store]:Instance Store type.
 
spotInstanceRequestId Returns the ID of Spot Instance request.  
stateTransitionReason Returns State Transition Reason.  
subnetId Returns Subnet ID.  
tenancy Returns Tenancy.  
virtualizationType Returns Virtualization Type.  
vpcId Returns VPC ID.  
Tags      
tag   Occurs for every tag that is assigned to the instance.  
key Returns the key of a tag assigned to the instance.  
value Returns the value of a tag assigned to the instance.  
securityGroups      
securityGroup   Occurs for every Security Group that is assigned to the instance.   
id Returns the ID of the Security Group.  
name Returns the name of Security Group.  

Mass data processing

Mass data processing is not supported.

PSP Usage

PSP is not supported.

Available component variables

Component variable name Description Remarks
error_code When AmazonServiceException is thrown, Amazon Web Services error code to which it corresponds is stored.
  • The value defaults to null.
status_code When AmazonService Exception is thrown, HTTP status code is stored.
  • The value defaults to null.
message_category Stroes the category to which corresponding message code belongs to, when an error occurs.
  • The value defaults to null.
message_code Stores its corresponding message code of occured error.
  • The value defaults to null.
message_level Stores the severity of the corresponding message code of the occured error.
  • The value defaults to null.
error_type Stores the type of the occured error.
  • The value defaults to null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The message may vary depending on DataSpider Servista version.
error_message Stores the error message for the occured error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version.
error_trace Stores stack trace of the occurred error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

None.

Main exceptions

Exception name Cause REMEDY
ResourceNotFoundException
Resource definition could not be found.Name: []
[Connect To] is not specified. Please specify [Connect To].
ResourceNotFoundException
Resource definition could not be found.Name: [<name of Global Resources>]
Resource definition selected in [Connect To] is not found. Please check the global resource specified in [Connect To].
InvalidPropertyConfigurationException
<Property Name> is not specified.
[<Property Name>] is not specified. Please specify [<Property Name>].
com.amazonaws.AmazonClientException
Unable to execute HTTP request: Connect to ec2.amazonaws.com/ec2.amazonaws.com/xxx.xxx.xxx.xxx timed out
Failed to send request to Amazon EC2. Request has exceeded the allotted millisecond value in [Timeout]. Try increasing the millisecond value in the [Timeout] or verify the network connectivity with Amazon EC2 service.
com.amazonaws.AmazonClientException
Unable to execute HTTP request: <Endpoint>
[Endpoint] specified by [Connect To] is not available. Make sure that all properties specified within the [Connect To] for the specified Global Resource are provided with correct information.

Notes