computing / Client / run_instances

run_instances

computing.Client.run_instances(**kwargs)

サーバーを新規作成します。1回のリクエストで、1つのサーバーを作成できます。

サーバーの作成には、時間がかかることがあります。このAPIのレスポンス「instanceState」を確認し「pending」が返ってきた、またはタイムアウトした場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

APIのパラメーターに「IpType」、「NetworkInterface.n.NetworkId」両方を指定しなかった場合、「IpType」パラメーターのdefault値が適用されます。

UserDataを指定してリクエストする場合は、POSTのみの対応となりますので、ご注意ください。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.run_instances(
    AccountingType='1'|'2',
    AddressingType='string',
    Admin='string',
    Agreement=True|False,
    BlockDeviceMapping=[
        {
            'DeviceName': 'string',
            'RequestEbs': {
                'DeleteOnTermination': True|False,
                'NoDevice': True|False,
                'SnapshotId': 'string',
                'VolumeSize': 123
            },
            'VirtualName': 'string'
        },
    ],
    Description='string',
    DisableApiTermination=True|False,
    ImageId='string',
    InstanceId='string',
    InstanceInitiatedShutdownBehavior='string',
    InstanceType='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',
    IpType='static'|'elastic'|'none',
    KernelId='string',
    KeyName='string',
    License=[
        {
            'LicenseName': 'RDS'|'Office(Std)'|'Office(Pro Plus)',
            'LicenseNum': 'string'
        },
    ],
    MaxCount=123,
    MinCount=123,
    Monitoring={
        'Enabled': True|False
    },
    NetworkInterface=[
        {
            'DeviceIndex': 123,
            'IpAddress': 'string',
            'ListOfRequestSecurityGroupId': [
                'string',
            ],
            'NetworkId': 'string',
            'NetworkName': 'string'
        },
    ],
    Password='string',
    Placement={
        'AvailabilityZone': 'string',
        'GroupName': 'string'
    },
    PublicIp='string',
    RamdiskId='string',
    SecurityGroup=[
        'string',
    ],
    SubnetId='string',
    UserData={
        'Content': 'string',
        'Encoding': 'string'
    }
)

Parameters:

• AccountingType (string) –

• AddressingType (string) –

• Admin (string) –

• Agreement (boolean) –

• BlockDeviceMapping (list) –

  • (dict) –

    • DeviceName (string) –

    • RequestEbs (dict) –

      • DeleteOnTermination (boolean) –

      • NoDevice (boolean) –

      • SnapshotId (string) –

      • VolumeSize (integer) –

    • VirtualName (string) –

• Description (string) –

• DisableApiTermination (boolean) –

• ImageId (string) – [REQUIRED]

• InstanceId (string) –

• InstanceInitiatedShutdownBehavior (string) –

• InstanceType (string) –

• IpType (string) –

• KernelId (string) –

• KeyName (string) –

• License (list) –

  • (dict) –

    • LicenseName (string) –

    • LicenseNum (string) –

• MaxCount (integer) –

• MinCount (integer) –

• Monitoring (dict) –

  • Enabled (boolean) –

• NetworkInterface (list) –

  • (dict) –

    • DeviceIndex (integer) –

    • IpAddress (string) –

    • ListOfRequestSecurityGroupId (list) –

      • (string) –

    • NetworkId (string) –

    • NetworkName (string) –

• Password (string) –

• Placement (dict) –

  • AvailabilityZone (string) –

  • GroupName (string) –

• PublicIp (string) –

• RamdiskId (string) –

• SecurityGroup (list) –

  • (string) –

• SubnetId (string) –

• UserData (dict) –

  • Content (string) –

  • Encoding (string) –

Return type:

dict

Returns:

Response Syntax

{
    'GroupSet': [
        {
            'GroupId': 'string'
        },
    ],
    'InstancesSet': [
        {
            'AccountingType': 'string',
            'Admin': 'string',
            'Architecture': 'string',
            'BlockDeviceMapping': [
                {
                    'DeviceName': 'string',
                    'Ebs': {
                        'DeleteOnTermination': 'string',
                        'Status': 'string',
                        'VolumeId': 'string',
                        'VolumeUniqueId': 'string'
                    }
                },
            ],
            'Description': 'string',
            'DnsName': 'string',
            'ImageId': 'string',
            'InstanceId': 'string',
            'InstanceState': {
                'Code': 123,
                'Name': 'string'
            },
            'InstanceType': 'string',
            'InstanceUniqueId': 'string',
            'IpAddress': 'string',
            'IpAddressV6': 'string',
            'IpType': 'string',
            'IsoImage': [
                {
                    'IsoImageId': 'string',
                    'IsoImageName': 'string'
                },
            ],
            'KeyName': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Monitoring': {
                'State': 'string'
            },
            'NetworkInterfaceSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string'
                    },
                    'Attachment': {
                        'AttachTime': 'string',
                        'AttachmentID': 'string',
                        'DeleteOnTermination': 'string',
                        'DeviceIndex': 'string',
                        'Status': 'string'
                    },
                    'Description': 'string',
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'NetworkInterfaceId': 'string',
                    'NiftyNetworkId': 'string',
                    'NiftyNetworkName': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddressesSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': 'string',
                    'Status': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'NiftyPrivateIpType': 'string',
            'Placement': {
                'AvailabilityZone': 'string'
            },
            'Platform': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddressV6': 'string',
            'Reason': 'string',
            'RootDeviceType': 'string'
        },
    ],
    'OwnerId': 'string',
    'RequestId': 'string',
    'ReservationId': 'string'
}

Response Structure

• (dict) –

  • GroupSet (list) –

    • (dict) –

      • GroupId (string) –

  • InstancesSet (list) –

    • (dict) –

      • AccountingType (string) –

      • Admin (string) –

      • Architecture (string) –

      • BlockDeviceMapping (list) –

        • (dict) –

          • DeviceName (string) –

          • Ebs (dict) –

            • DeleteOnTermination (string) –

            • Status (string) –

            • VolumeId (string) –

            • VolumeUniqueId (string) –

      • Description (string) –

      • DnsName (string) –

      • ImageId (string) –

      • InstanceId (string) –

      • InstanceState (dict) –

        • Code (integer) –

        • Name (string) –

      • InstanceType (string) –

      • InstanceUniqueId (string) –

      • IpAddress (string) –

      • IpAddressV6 (string) –

      • IpType (string) –

      • IsoImage (list) –

        • (dict) –

          • IsoImageId (string) –

          • IsoImageName (string) –

      • KeyName (string) –

      • LaunchTime (datetime) –

      • Monitoring (dict) –

        • State (string) –

      • NetworkInterfaceSet (list) –

        • (dict) –

          • Association (dict) –

            • IpOwnerId (string) –

            • PublicDnsName (string) –

            • PublicIp (string) –

          • Attachment (dict) –

            • AttachTime (string) –

            • AttachmentID (string) –

            • DeleteOnTermination (string) –

            • DeviceIndex (string) –

            • Status (string) –

          • Description (string) –

          • GroupSet (list) –

            • (dict) –

              • GroupId (string) –

          • NetworkInterfaceId (string) –

          • NiftyNetworkId (string) –

          • NiftyNetworkName (string) –

          • OwnerId (string) –

          • PrivateDnsName (string) –

          • PrivateIpAddressesSet (list) –

            • (dict) –

              • Association (dict) –

                • IpOwnerId (string) –

                • PublicDnsName (string) –

                • PublicIp (string) –

              • Primary (boolean) –

              • PrivateDnsName (string) –

              • PrivateIpAddress (string) –

          • SourceDestCheck (string) –

          • Status (string) –

          • SubnetId (string) –

          • VpcId (string) –

      • NiftyPrivateIpType (string) –

      • Placement (dict) –

        • AvailabilityZone (string) –

      • Platform (string) –

      • PrivateDnsName (string) –

      • PrivateIpAddress (string) –

      • PrivateIpAddressV6 (string) –

      • Reason (string) –

      • RootDeviceType (string) –

  • OwnerId (string) –

  • RequestId (string) –

  • ReservationId (string) –