computing / Client / start_instances

start_instances

computing.Client.start_instances(**kwargs)

指定したサーバーを起動します。

サーバーを指定するためには、サーバー名が必要です。

サーバーの起動には、時間がかかることがあります。このAPIのレスポンス「currentState.name」を確認して「pending」が返ってきた場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

NiftyIsBiosをtrueに指定すると、BIOS起動画面で停止した状態となります。コンソールからBIOS設定操作を行ってください。

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

サーバー起動時にサーバータイプ変更を行う場合、一部のサーバータイプは一度に指定できる起動台数が1台のみです。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.start_instances(
    AccountingType=[
        'string',
    ],
    InstanceId=[
        'string',
    ],
    InstanceType=[
        'string',
    ],
    NiftyIsBios=True|False,
    Tenancy=[
        'string',
    ],
    UserData={
        'Content': 'string',
        'Encoding': 'string'
    }
)

Parameters:

• AccountingType (list) –

  • (string) –

• InstanceId (list) –

  [REQUIRED]

  • (string) –

• InstanceType (list) –

  • (string) –

• NiftyIsBios (boolean) –

• Tenancy (list) –

  • (string) –

• UserData (dict) –

  • Content (string) –

  • Encoding (string) –

Return type:

dict

Returns:

Response Syntax

{
    'InstancesSet': [
        {
            'CurrentState': {
                'Code': 123,
                'Name': 'string'
            },
            'InstanceId': 'string',
            'InstanceUniqueId': 'string',
            'PreviousState': {
                'Code': 123,
                'Name': 'string'
            },
            'Tenancy': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • InstancesSet (list) –

    • (dict) –

      • CurrentState (dict) –

        • Code (integer) –

        • Name (string) –

      • InstanceId (string) –

      • InstanceUniqueId (string) –

      • PreviousState (dict) –

        • Code (integer) –

        • Name (string) –

      • Tenancy (string) –

  • RequestId (string) –