computing / Client / describe_customer_gateways

describe_customer_gateways

computing.Client.describe_customer_gateways(**kwargs)

指定したカスタマーゲートウェイの情報を取得します。

カスタマーゲートウェイを指定するためには、カスタマーゲートウェイユニークIDまたはカスタマーゲートウェイ名が必要です。

カスタマーゲートウェイを指定しない場合、取得できるすべてのカスタマーゲートウェイ情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「¥」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。

曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。

• ip-address

• nifty-customer-gateway-name

• nifty-customer-gateway-description

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_customer_gateways(
    CustomerGatewayId=[
        'string',
    ],
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'customer-gateway-id'|'nifty-customer-gateway-name'|'ip-address'|'state'|'nifty-customer-gateway-description'
        },
    ],
    NiftyCustomerGatewayName=[
        'string',
    ]
)

Parameters:

• CustomerGatewayId (list) –

  • (string) –

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• NiftyCustomerGatewayName (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CustomerGatewaySet': [
        {
            'CreatedTime': datetime(2015, 1, 1),
            'CustomerGatewayId': 'string',
            'IpAddress': 'string',
            'NiftyCustomerGatewayDescription': 'string',
            'NiftyCustomerGatewayName': 'string',
            'NiftyLanSideCidrBlock': 'string',
            'NiftyLanSideIpAddress': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • CustomerGatewaySet (list) –

    • (dict) –

      • CreatedTime (datetime) –

      • CustomerGatewayId (string) –

      • IpAddress (string) –

      • NiftyCustomerGatewayDescription (string) –

      • NiftyCustomerGatewayName (string) –

      • NiftyLanSideCidrBlock (string) –

      • NiftyLanSideIpAddress (string) –

      • State (string) –

      • TagSet (list) –

        • (dict) –

          • Key (string) –

          • Value (string) –

  • RequestId (string) –