computing / Client / describe_security_groups

describe_security_groups

computing.Client.describe_security_groups(**kwargs)

指定したファイアウォールグループの設定情報を取得します。

ファイアウォールグループを指定するためには、ファイアウォールグループ名が必要です。指定しない場合は、取得可能なすべてのファイアウォールグループの設定情報を取得します。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_security_groups(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'description'|'group-name'
        },
    ],
    GroupName=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• GroupName (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'SecurityGroupInfo': [
        {
            'AvailabilityZone': 'string',
            'GroupDescription': 'string',
            'GroupLogFilterBroadcast': True|False,
            'GroupLogFilterNetBios': True|False,
            'GroupLogLimit': 123,
            'GroupName': 'string',
            'GroupRuleLimit': 123,
            'GroupStatus': 'string',
            'InstanceUniqueIdsSet': [
                {
                    'InstanceUniqueId': 'string'
                },
            ],
            'InstancesSet': [
                {
                    'InstanceId': 'string'
                },
            ],
            'IpPermissions': [
                {
                    'AddDatetime': datetime(2015, 1, 1),
                    'Description': 'string',
                    'FromPort': 123,
                    'Groups': [
                        {
                            'GroupName': 'string',
                            'UserId': 'string'
                        },
                    ],
                    'InOut': 'string',
                    'IpProtocol': 'string',
                    'IpRanges': [
                        {
                            'CidrIp': 'string'
                        },
                    ],
                    'ToPort': 123
                },
            ],
            'OwnerId': 'string',
            'RouterSet': [
                {
                    'RouterId': 'string',
                    'RouterName': 'string'
                },
            ],
            'VpnGatewaySet': [
                {
                    'NiftyVpnGatewayName': 'string',
                    'VpnGatewayId': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • SecurityGroupInfo (list) –

    • (dict) –

      • AvailabilityZone (string) –

      • GroupDescription (string) –

      • GroupLogFilterBroadcast (boolean) –

      • GroupLogFilterNetBios (boolean) –

      • GroupLogLimit (integer) –

      • GroupName (string) –

      • GroupRuleLimit (integer) –

      • GroupStatus (string) –

      • InstanceUniqueIdsSet (list) –

        • (dict) –

          • InstanceUniqueId (string) –

      • InstancesSet (list) –

        • (dict) –

          • InstanceId (string) –

      • IpPermissions (list) –

        • (dict) –

          • AddDatetime (datetime) –

          • Description (string) –

          • FromPort (integer) –

          • Groups (list) –

            • (dict) –

              • GroupName (string) –

              • UserId (string) –

          • InOut (string) –

          • IpProtocol (string) –

          • IpRanges (list) –

            • (dict) –

              • CidrIp (string) –

          • ToPort (integer) –

      • OwnerId (string) –

      • RouterSet (list) –

        • (dict) –

          • RouterId (string) –

          • RouterName (string) –

      • VpnGatewaySet (list) –

        • (dict) –

          • NiftyVpnGatewayName (string) –

          • VpnGatewayId (string) –