run-instances
Description
サーバーを新規作成します。1回のリクエストで、1つのサーバーを作成できます。
サーバーの作成には、時間がかかることがあります。このAPIのレスポンス「instanceState」を確認し「pending」が返ってきた、またはタイムアウトした場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。
APIのパラメーターに「IpType」、「NetworkInterface.n.NetworkId」両方を指定しなかった場合、「IpType」パラメーターのdefault値が適用されます。
UserDataを指定してリクエストする場合は、POSTのみの対応となりますので、ご注意ください。
See also: NIFCLOUD API Documentation
Synopsis
run-instances
[--accounting-type <value>]
[--addressing-type <value>]
[--admin <value>]
[--agreement | --no-agreement]
[--block-device-mapping <value>]
[--description <value>]
[--disable-api-termination | --no-disable-api-termination]
--image-id <value>
[--instance-id <value>]
[--instance-initiated-shutdown-behavior <value>]
[--instance-type <value>]
[--ip-type <value>]
[--kernel-id <value>]
[--key-name <value>]
[--license <value>]
[--max-count <value>]
[--min-count <value>]
[--monitoring <value>]
[--network-interface <value>]
[--password <value>]
[--placement <value>]
[--public-ip <value>]
[--ramdisk-id <value>]
[--security-group <value>]
[--subnet-id <value>]
[--user-data <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options
--accounting-type
(string)
Possible values:
1
2
--addressing-type
(string)
--admin
(string)
--agreement
| --no-agreement
(boolean)
--block-device-mapping
(list)
(structure)
DeviceName -> (string)
RequestEbs -> (structure)
DeleteOnTermination -> (boolean)
NoDevice -> (boolean)
SnapshotId -> (string)
VolumeSize -> (integer)
VirtualName -> (string)
Shorthand Syntax:
DeviceName=string,RequestEbs={DeleteOnTermination=boolean,NoDevice=boolean,SnapshotId=string,VolumeSize=integer},VirtualName=string ...
JSON Syntax:
[
{
"DeviceName": "string",
"RequestEbs": {
"DeleteOnTermination": true|false,
"NoDevice": true|false,
"SnapshotId": "string",
"VolumeSize": integer
},
"VirtualName": "string"
}
...
]
--description
(string)
--disable-api-termination
| --no-disable-api-termination
(boolean)
--image-id
(string)
--instance-id
(string)
--instance-initiated-shutdown-behavior
(string)
--instance-type
(string)
Possible values:
e2-mini
e-mini
h2-mini
mini
c2-small
c2r-small
c-small
e2-small
e2r-small
e-small
h2-small
h2r-small
small
c2-small2
c2r-small2
c-small2
e2-small2
e2r-small2
e-small2
h2-small2
h2r-small2
small2
c2-small4
c-small4
e2-small4
e-small4
h2-small4
h2r-small4
small4
e2-small8
e-small8
h2-small8
small8
e2-small16
e-small16
h2-small16
small16
c2-medium
c2r-medium
c-medium
e2-medium
e2r-medium
e-medium
h2-medium
h2r-medium
medium
c2-medium4
c2r-medium4
c-medium4
e2-medium4
e2r-medium4
e-medium4
h2-medium4
h2r-medium4
medium4
c2-medium8
c-medium8
e2-medium8
e-medium8
h2-medium8
h2r-medium8
medium8
e2-medium16
e-medium16
h2-medium16
medium16
e2-medium24
e-medium24
h2-medium24
medium24
c2-large
c2r-large
c-large
e2-large
e2r-large
e-large
h2-large
h2r-large
large
c2-large8
c-large8
e2-large8
e2r-large8
e-large8
h2-large8
h2r-large8
large8
e2-large16
e-large16
h2-large16
h2r-large16
large16
e2-large24
e-large24
h2-large24
large24
e2-large32
e-large32
h2-large32
large32
e2-extra-large8
e2r-extra-large8
e-extra-large8
h2-extra-large8
h2r-extra-large8
extra-large8
e2-extra-large16
e-extra-large16
h2-extra-large16
h2r-extra-large16
extra-large16
e2-extra-large24
e-extra-large24
h2-extra-large24
h2r-extra-large24
extra-large24
e2-extra-large32
e-extra-large32
h2-extra-large32
extra-large32
e2-extra-large48
e-extra-large48
h2-extra-large48
extra-large48
e2-double-large16
e2r-double-large16
e-double-large16
h2-double-large16
h2r-double-large16
double-large16
e2-double-large24
e-double-large24
h2-double-large24
h2r-double-large24
double-large24
e2-double-large32
e-double-large32
h2-double-large32
h2r-double-large32
double-large32
e2-double-large48
e-double-large48
h2-double-large48
double-large48
e2-double-large64
e-double-large64
h2-double-large64
double-large64
e2-double-large96
e-double-large96
h2-double-large96
double-large96
h2-triple-large32
h2r-triple-large32
triple-large32
h2-triple-large48
h2r-triple-large48
triple-large48
h2-triple-large64
triple-large64
h2-triple-large96
triple-large96
h2-triple-large128
triple-large128
h2-quad-large64
h2r-quad-large64
quad-large64
h2-quad-large96
quad-large96
h2-quad-large128
quad-large128
h2-quad-large256
quad-large256
h2-septa-large128
septa-large128
h2-septa-large256
septa-large256
h2-octa-large256
octa-large256
h2-octa-large384
octa-large384
h2-octa-large512
octa-large512
--ip-type
(string)
Possible values:
static
elastic
none
--kernel-id
(string)
--key-name
(string)
--license
(list)
(structure)
LicenseName -> (string)
LicenseNum -> (string)
Shorthand Syntax:
LicenseName=string,LicenseNum=string ...
JSON Syntax:
[
{
"LicenseName": "RDS"|"Office(Std)"|"Office(Pro Plus)",
"LicenseNum": "string"
}
...
]
--max-count
(integer)
--min-count
(integer)
--monitoring
(structure)
Enabled -> (boolean)
Shorthand Syntax:
Enabled=boolean
JSON Syntax:
{
"Enabled": true|false
}
--network-interface
(list)
(structure)
DeviceIndex -> (integer)
IpAddress -> (string)
ListOfRequestSecurityGroupId -> (list)
(string)
NetworkId -> (string)
NetworkName -> (string)
Shorthand Syntax:
DeviceIndex=integer,IpAddress=string,ListOfRequestSecurityGroupId=string,string,NetworkId=string,NetworkName=string ...
JSON Syntax:
[
{
"DeviceIndex": integer,
"IpAddress": "string",
"ListOfRequestSecurityGroupId": ["string", ...],
"NetworkId": "string",
"NetworkName": "string"
}
...
]
--password
(string)
--placement
(structure)
AvailabilityZone -> (string)
GroupName -> (string)
Shorthand Syntax:
AvailabilityZone=string,GroupName=string
JSON Syntax:
{
"AvailabilityZone": "string",
"GroupName": "string"
}
--public-ip
(string)
--ramdisk-id
(string)
--security-group
(list)
(string)
Syntax:
"string" "string" ...
--subnet-id
(string)
--user-data
(structure)
Content -> (string)
Encoding -> (string)
Shorthand Syntax:
Content=string,Encoding=string
JSON Syntax:
{
"Content": "string",
"Encoding": "string"
}
Global Options
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output
GroupSet -> (list)
(structure)
GroupId -> (string)
InstancesSet -> (list)
(structure)
AccountingType -> (string)
Admin -> (string)
Architecture -> (string)
BlockDeviceMapping -> (list)
(structure)
DeviceName -> (string)
Ebs -> (structure)
DeleteOnTermination -> (string)
Status -> (string)
VolumeId -> (string)
VolumeUniqueId -> (string)
Description -> (string)
DnsName -> (string)
ImageId -> (string)
InstanceId -> (string)
InstanceState -> (structure)
Code -> (integer)
Name -> (string)
InstanceType -> (string)
InstanceUniqueId -> (string)
IpAddress -> (string)
IpAddressV6 -> (string)
IpType -> (string)
IsoImage -> (list)
(structure)
IsoImageId -> (string)
IsoImageName -> (string)
KeyName -> (string)
LaunchTime -> (timestamp)
Monitoring -> (structure)
State -> (string)
NetworkInterfaceSet -> (list)
(structure)
Association -> (structure)
IpOwnerId -> (string)
PublicDnsName -> (string)
PublicIp -> (string)
Attachment -> (structure)
AttachTime -> (string)
AttachmentID -> (string)
DeleteOnTermination -> (string)
DeviceIndex -> (string)
Status -> (string)
Description -> (string)
GroupSet -> (list)
(structure)
GroupId -> (string)
NetworkInterfaceId -> (string)
NiftyNetworkId -> (string)
NiftyNetworkName -> (string)
OwnerId -> (string)
PrivateDnsName -> (string)
PrivateIpAddressesSet -> (list)
(structure)
Association -> (structure)
IpOwnerId -> (string)
PublicDnsName -> (string)
PublicIp -> (string)
Primary -> (boolean)
PrivateDnsName -> (string)
PrivateIpAddress -> (string)
SourceDestCheck -> (string)
Status -> (string)
SubnetId -> (string)
VpcId -> (string)
NiftyPrivateIpType -> (string)
Placement -> (structure)
AvailabilityZone -> (string)
Platform -> (string)
PrivateDnsName -> (string)
PrivateIpAddress -> (string)
PrivateIpAddressV6 -> (string)
Reason -> (string)
RootDeviceType -> (string)
OwnerId -> (string)
RequestId -> (string)
ReservationId -> (string)