computing / Client / terminate_instances

terminate_instances

computing.Client.terminate_instances(**kwargs)

指定したサーバーを削除します。

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

サーバーの削除には、時間がかかることがあります。このAPIのレスポンス「currentState.name」を確認して「pending」が返ってきた場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。また、API「DescribeInstances」のレスポンスに該当情報がない場合は、削除処理は成功しています。

アップロード中またはインポート中のサーバーを、このAPIで削除することはできません。API「CancelUpload」を使用してください。

関連する付替IPアドレス設定もあわせて解除します。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.terminate_instances(
    InstanceId=[
        'string',
    ]
)

Parameters:

InstanceId (list) –

[REQUIRED]

• (string) –

Return type:

dict

Returns:

Response Syntax

{
    'InstancesSet': [
        {
            'CurrentState': {
                'Code': 123,
                'Name': 'string'
            },
            'InstanceId': 'string',
            'InstanceUniqueId': 'string',
            'PreviousState': {
                'Code': 123,
                'Name': '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) –

  • RequestId (string) –