computing / Client / stop_instances

stop_instances

computing.Client.stop_instances(**kwargs)

指定したサーバーを停止します。

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

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

なお、強制オプションに「true」を指定して実行した際に、サーバーが停止できない状態などのエラーが返されることがあります。強制オプションに「true」を指定して実行した場合には、システムチェックや修復を行うことをおすすめします。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.stop_instances(
    Force=True|False,
    InstanceId=[
        'string',
    ],
    Tenancy=[
        'string',
    ]
)

Parameters:

• Force (boolean) –

• InstanceId (list) –

  [REQUIRED]

  • (string) –

• Tenancy (list) –

  • (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) –