nas / Client / clear_nas_session

clear_nas_session

nas.Client.clear_nas_session(**kwargs)

NASのセッションクリアを行います。

NASのセッションクリアを行うと通信断(目安:5分程度)が発生し、その間NASのステータスはclearing-session(セッションクリア中)となります。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.clear_nas_session(
    NASInstanceIdentifier='string',
    SessionClearType='0'|'1'
)
Parameters:
  • NASInstanceIdentifier (string) – [REQUIRED]

  • SessionClearType (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NASInstance': {
        'AllocatedStorage': 123,
        'AuthenticationType': 123,
        'AvailabilityZone': 'string',
        'Endpoint': {
            'Address': 'string',
            'PrivateAddress': 'string'
        },
        'MasterUsername': 'string',
        'NASInstanceClass': 'string',
        'NASInstanceDescription': 'string',
        'NASInstanceErrorInfo': {
            'NASInstanceErrorCode': 'string',
            'NASInstanceErrorMessage': 'string'
        },
        'NASInstanceIdentifier': 'string',
        'NASInstanceStatus': 'string',
        'NASInstanceType': 123,
        'NASSecurityGroups': [
            {
                'NASSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'NetworkId': 'string',
        'NoRootSquash': True|False,
        'Protocol': 'string',
        'StorageType': 123,
        'UpgradeRequired': True|False
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –

    • NASInstance (dict) –

      • AllocatedStorage (integer) –

      • AuthenticationType (integer) –

      • AvailabilityZone (string) –

      • Endpoint (dict) –

        • Address (string) –

        • PrivateAddress (string) –

      • MasterUsername (string) –

      • NASInstanceClass (string) –

      • NASInstanceDescription (string) –

      • NASInstanceErrorInfo (dict) –

        • NASInstanceErrorCode (string) –

        • NASInstanceErrorMessage (string) –

      • NASInstanceIdentifier (string) –

      • NASInstanceStatus (string) –

      • NASInstanceType (integer) –

      • NASSecurityGroups (list) –

        • (dict) –

          • NASSecurityGroupName (string) –

          • Status (string) –

      • NetworkId (string) –

      • NoRootSquash (boolean) –

      • Protocol (string) –

      • StorageType (integer) –

      • UpgradeRequired (boolean) –

    • ResponseMetadata (dict) –

      • RequestId (string) –