ユーザーガイド/リファレンスガイド

Network API v2.0

Description

セキュリティグループルールを削除します。
APIからコントロールパネル上のセキュリティグループルールを削除することはできません。

Request URL

Network API v2.0
DELETE /v2.0/security-group-rules/{rules-security-groups-id}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
rules-security-groups-id セキュリティグループルールID header セキュリティグループルールIDを指定します。

Response

Normal response codes

200

Example

Request

curl -i -X DELETE \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/security-group-rules/セキュリティグループルールID

Response

HTTP/1.1 204 No Content
Date: Fri, 08 Jul 2016 07:21:32 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json

 

Description

セキュリティグループ ルールを作成します。
セキュリティグループIDを指定する必要があります。
APIからコントロールパネル上のセキュリティグループにルールは追加することができません。
セキュリティグループ ルールは100個まで作成可能です。
プロトコルに「icmp」を指定する場合、最小ポート番号と最大ポート番号にそれぞれICMP Typeを指定する必要があります。
アウトバウンド(egress)は常に全許可の状態になります。

Request URL

Network API v2.0
POST /v2.0/security-group-rules

Request Json

{
    “security_group_rule”: {
        “direction”: “適用するトラフィックの向き“,
        “ethertype”: “イーサタイプ“,
        “security_group_id”: “セキュリティグループID“,
        “port_range_min”: “最小ポート番号“,
        “port_range_max”: “最大ポート番号“,
        “protocol”: “プロトコル
    }
}

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
direction ingress plain 指定するルールがどのトラフィックの向きに適用するかを指定します。「インバウンド(ingress)」のみ指定可能です。
ethertype IPv4
IPv6
plain イーサタイプを指定します。
port_range_min (Optional) ポート番号
ICMPタイプ
plain 開放するポート番号 もしくは ICMPタイプを指定します。
範囲で設定する場合は最小ポート番号 もしくは ICMPタイプになります。
(ポート開放/ICMP許可)
port_range_max (Optional) ポート番号
ICMPタイプ
plain 開放するポート番号 もしくは ICMPタイプを指定します。
範囲で設定する場合は最大ポート番号 もしくは ICMPタイプになります。
(ポート開放/ICMP許可)
protocol (Optional) tcp
udp
icmp
null
plain プロトコルを指定します。 
「icmp」を指定する場合、最小ポート番号と最大ポート番号にそれぞれICMP Typeを指定する必要があります。
remote_group_id (Optional) セキュリティグループID plain 指定したセキュリティグループIDに紐付いたポートからのトラフィックのみを許可する際に指定します。
remote_ip_prefix (Optional) 許可IP plain 指定したIPからのトラフィックのみを許可したい場合に指定します。
(接続元IP制限)

Response

Normal response codes

201

Example

Request

curl -i -X POST \{
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
-d ‘{“security_group_rule”: {“direction”: “ルールを適用するトラフィックの向き“, “ethertype”: “イーサタイプ“, “security_group_id”: “セキュリティグループID“, “port_range_min”: “ポート番号“, “port_range_max”: “ポート番号“, “protocol”: “プロトコル“}}’ \
https://networking.odc01.eva-clouds.com/v2.0/security-group-rules

Response

HTTP/1.1 201 Created
Date: Fri, 08 Jul 2016 06:31:48 GMT
Server: Apache
Content-Length: 340
Content-Type: application/json

{
    “security_group_rule”: {
        “direction”: “ルールを適用するトラフィックの向き“,
        “ethertype”: “イーサタイプ“,
        “id”: “セキュリティグループルールID“,
        “port_range_max”: ポート番号,
        “port_range_min”: ポート番号,
        “protocol”: “プロトコル“,
        “remote_group_id”: null,
        “remote_ip_prefix”: null,
        “security_group_id”: “セキュリティグループID“,
        “tenant_id”: “テナントID
    }
}

 

Description

セキュリティグループルールの詳細を取得します。

Request URL

Network API v2.0
GET /v2.0/security-group-rules/{rules-security-groups-id}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
rules-security-groups-id セキュリティグループルールID header セキュリティグループルールIDを指定します。

 

Response

Normal response codes

200

Example

Request

curl -i -X GET 
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/security-group-rules/セキュリティグループルールID

Response

HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 01:38:30 GMT
Server: Apache
Content-Length: 377
Content-Type: application/json

{
    “security_group_rule”: {
        “direction”: “ルールを適用するトラフィックの向き“,
        “ethertype”: “イーサタイプ“,
        “id”: “セキュリティグループルールID“,
        “port_range_max”: null,
        “port_range_min”: null,
        “protocol”: null,
        “remote_group_id”: “d490a79d-2799-48b0-804d-01501f89bf70”,
        “remote_ip_prefix”: null,
        “security_group_id”: “セキュリティグループID“,
        “tenant_id”: “テナントID
    }
}

 

Description

セキュリティグループルールの一覧を取得します。

Request URL

Network API v2.0
GET /v2.0/security-group-rules

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID

Response

Normal response codes

200

Example

Request

curl -i -X GET \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/security-group-rules

Response

HTTP/1.1 200 OK
Date: Fri, 08 Jul 2016 01:58:29 GMT
Server: Apache
Content-Length: 1372
Content-Type: application/json

{
    “security_group_rules”: [
        {
            “direction”: “ルールを適用するトラフィックの向き“,
             “ethertype”: “イーサタイプ“,
             “id”: “セキュリティグループルールID“,
             “port_range_max”: null,
             “port_range_min”: null,
             “protocol”: null,
             “remote_group_id”: null,
             “remote_ip_prefix”: null,
             “security_group_id”: “セキュリティグループID“,
             “tenant_id”: “テナントID
        },
         {
            “direction”: “ルールを適用するトラフィックの向き“,
             “ethertype”: “イーサタイプ“,
             “id”: “セキュリティグループルールID“,
             “port_range_max”: null,
             “port_range_min”: null,
             “protocol”: null,
             “remote_group_id”: null,
             “remote_ip_prefix”: null,
             “security_group_id”: “セキュリティグループルールID“,
             “tenant_id”: “テナントID
        },
         {
            “direction”: “ルールを適用するトラフィックの向き“,
             “ethertype”: “イーサタイプ“,
             “id”: “セキュリティグループルールID“,
             “port_range_max”: null,
             “port_range_min”: null,
             “protocol”: null,
             “remote_group_id”: null,
             “remote_ip_prefix”: null,
             “security_group_id”: “セキュリティグループルールID“,
             “tenant_id”: “テナントID
        },
        {
            “direction”: “ルールを適用するトラフィックの向き“,
             “ethertype”: “イーサタイプ“,
             “id”: “セキュリティグループルールID“,
             “port_range_max”: null,
             “port_range_min”: null,
             “protocol”: null,
             “remote_group_id”: null,
             “remote_ip_prefix”: null,
             “security_group_id”: “セキュリティグループルールID“,
             “tenant_id”: “テナントID
        },
    ] }

 

Description

作成済みのセキュリティグループを削除します。
なお、セキュリティグループを削除した際に設定されていたセキュリティグループルールも同時に削除されます。
また、APIからコントロールパネル上のセキュリティグループは削除することができません。

Request URL

Network API v2.0
DELETE /v2.0/security-groups/{security_group_id}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
security_group_id セキュリティグループID URI セキュリティグループIDを指定します。

Response

Normal response codes

204

Example

Request

curl -i -X DELETE \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/security-groups/セキュリティグループID

Response

HTTP/1.1 204 No Content
Date: Fri, 08 Jul 2016 01:41:56 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json

 

Description

作成済みのセキュリティグループを更新します。
APIからコントロールパネル上のセキュリティグループは更新することができません。
また、コントロールパネル上のセキュリティグループと同一の名前は付けることができません。

Request URL

Network API v2.0
PUT /v2.0/security-groups/{security_group_id}

Request Json

{
    “security_group”: {
        “name”: “セキュリティグループの名前“,
        “description”: “セキュリティグループの説明や概要
    }
}

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
security_group_id セキュリティグループID URI セキュリティグループIDを指定します。
name セキュリティグループの名前 plain セキュリティグループに任意の名前を指定します。
名前の重複はできません。
description (Optional) セキュリティグループの説明・概要 plain セキュリティグループに任意の説明・概要を指定します。

Response

Normal response codes

200

Example

Request

curl -i -X PUT \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
-d ‘{“security_group”: {“name”: “セキュリティグループの名前“,”description”: “セキュリティグループの説明や概要“}}’ \
https://networking.odc01.eva-clouds.com/v2.0/security-groups/セキュリティグループID

Response

HTTP/1.1 200 OK
Date: Thu, 07 Jul 2016 09:59:42 GMT
Server: Apache
Content-Length: 843
Content-Type: application/json

{
    “security_group”: {
        “description”: “セキュリティグループの説明や概要“,
         “id”: “セキュリティグループID“,
         “name”: “セキュリティグループの名前“,
         “security_group_rules”: [
            {
                “direction”: “ルールを適用するトラフィックの向き“,
                 “ethertype”: “イーサタイプ“,
                 “id”: “セキュリティグループルールID“,
                 “port_range_max”: null,
                 “port_range_min”: null,
                 “protocol”: null,
                 “remote_group_id”: null,
                 “remote_ip_prefix”: null,
                 “security_group_id”: “セキュリティグループID“,
                 “tenant_id”: “テナントID
            },
             {
                “direction”: “ルールを適用するトラフィックの向き“,
                 “ethertype”: “イーサタイプ“,
                 “id”: “セキュリティグループルールID“,
                 “port_range_max”: null,
                 “port_range_min”: null,
                 “protocol”: null,
                 “remote_group_id”: null,
                 “remote_ip_prefix”: null,
                 “security_group_id”: “セキュリティグループID“,
                 “tenant_id”: “テナントID
            }
        ],
         “tenant_id”: “テナントID
    }
}

 

Description

新しいセキュリティグループを作成します。
セキュリティグループは50個まで作成可能です。
なお、APIから作成したセキュリティグループは、コントロールパネルから使用することができません。

Request URL

Network API v2.0
POST /v2.0/security-groups

Request Json

{
    “security_group”: {
        “name”: “セキュリティグループの名前“,
        “description”: “セキュリティグループの説明や概要
    }
}

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
name セキュリティグループの名前 plain セキュリティグループに任意の名前を指定します。
名前の重複はできません。
description (Optional) セキュリティグループの説明・概要 plain セキュリティグループに任意の説明・概要を指定します。

Response

Normal response codes

201

Example

Request

curl -i -X POST \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
-d ‘{“security_group”: {“name”: “セキュリティグループの名前“}}’ \
https://networking.odc01.eva-clouds.com/v2.0/security-groups

Response

HTTP/1.1 201 Created
Date: Thu, 07 Jul 2016 07:13:32 GMT
Server: Apache
Content-Length: 817
Content-Type: application/json

{
    “security_group”: {
        “description”: “”,
        “id”: “セキュリティグループID“,
        “name”: “セキュリティグループの名前“,
        “security_group_rules”: [
            {
                “direction”: “ルールを適用するトラフィックの向き“,
                “ethertype”: “イーサタイプ“,
                “id”: “セキュリティグループルールID“,
                “port_range_max”: null,
                “port_range_min”: null,
                “protocol”: null,
                “remote_group_id”: null,
                “remote_ip_prefix”: null,
                “security_group_id”: “セキュリティグループID“,
                “tenant_id”: “テナントID
            },
            {
                “direction”: “ルールを適用するトラフィックの向き“,
                “ethertype”: “イーサタイプ“,
                “id”: “セキュリティグループルールID“,
                “port_range_max”: null,
                “port_range_min”: null,
                “protocol”: null,
                “remote_group_id”: null,
                “remote_ip_prefix”: null,
                “security_group_id”: “セキュリティグループID“,
                “tenant_id”: “テナントID
            }
        ],
        “tenant_id”: “テナントID
    }
}

 

Description

セキュリティグループの詳細を取得します。

Request URL

Network API v2.0
GET /v2.0/security-groups/{security_group_id}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
security_group_id セキュリティグループID URI セキュリティグループIDを指定します。

Response

Normal response codes

200

Example

Request

curl -i -X GET \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/security-groups/セキュリティグループID

Response

HTTP/1.1 200 OK
Date: Thu, 07 Jul 2016 05:07:23 GMT
Server: Apache
Content-Length: 1532
Content-Type: application/json

{
    “security_group”: {
        “description”: “セキュリティグループの説明や概要“,
         “id”: “セキュリティグループID“,
         “name”: “セキュリティグループの名前“,
         “security_group_rules”: [
            {
                “direction”: “ルールを適用するトラフィックの向き“,
                 “ethertype”: “イーサタイプ“,
                 “id”: “セキュリティグループルールID“,
                 “port_range_max”: null,
                 “port_range_min”: null,
                 “protocol”: null,
                 “remote_group_id”: null,
                 “remote_ip_prefix”: null,
                 “security_group_id”: “セキュリティグループID“,
                 “tenant_id”: “テナントID
            },
             {
                “direction”: “ルールを適用するトラフィックの向き“,
                 “ethertype”: “イーサタイプ“,
                 “id”: “セキュリティグループルールID“,
                 “port_range_max”: null,
                 “port_range_min”: null,
                 “protocol”: null,
                 “remote_group_id”: null,
                 “remote_ip_prefix”: null,
                 “security_group_id”: “セキュリティグループID“,
                 “tenant_id”: “テナントID
            },
             {
                “direction”: “ルールを適用するトラフィックの向き“,
                 “ethertype”: “イーサタイプ“,
                 “id”: “セキュリティグループルールID“,
                 “port_range_max”: null,
                 “port_range_min”: null,
                 “protocol”: null,
                 “remote_group_id”: null,
                 “remote_ip_prefix”: null,
                 “security_group_id”: “セキュリティグループID“,
                 “tenant_id”: “テナントID
            },
             {
                “direction”: “ルールを適用するトラフィックの向き“,
                 “ethertype”: “イーサタイプ“,
                 “id”: “セキュリティグループルールID“,
                 “port_range_max”: null,
                 “port_range_min”: null,
                 “protocol”: null,
                 “remote_group_id”: null,
                 “remote_ip_prefix”: null,
                 “security_group_id”: “セキュリティグループID“,
                 “tenant_id”: “テナントID
            },
         ],
         “tenant_id”: “テナントID
    }
}

 

Description

セキュリティグループ一覧を取得します。

Request URL

Network API v2.0
GET /v2.0/security-groups

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID

Response

Normal response codes

200

Example

Requestcurl -i -X GET \
-H “Accept: application/json” \
-H “Content-Type: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/security-groups

Response

HTTP/1.1 200 OK
Date: Thu, 07 Jul 2016 05:18:51 GMT
Server: Apache
Content-Length: 1535
Content-Type: application/json

{
    “security_groups”: [
        {
            “tenant_id”: “テナントID“,
            “description”: “セキュリティグループの説明や概要”,
            “id”: “セキュリティグループID”,
            “security_group_rules”: [
                {
                    “remote_group_id”: null,
                    “direction”: “ルールを適用するトラフィックの向き“,
                    “remote_ip_prefix”: null,
                    “protocol”: null,
                    “ethertype”: “イーサタイプ“,
                    “tenant_id”: “テナントID“,
                    “port_range_max”: null,
                    “port_range_min”: null,
                    “id”: “セキュリティグループルールID“,
                    “security_group_id”: “セキュリティグループID
                },
                {
                    “remote_group_id”: “通信を許可するセキュリティグループID“,
                    “direction”: “ルールを適用するトラフィックの向き“,
                    “remote_ip_prefix”: null,
                    “protocol”: null,
                    “ethertype”: “イーサタイプ“,
                    “tenant_id”: “テナントID“,
                    “port_range_max”: null,
                    “port_range_min”: null,
                    “id”: “セキュリティグループルールID“,
                    “security_group_id”: “セキュリティグループID
                }
            ],
            “name”: “セキュリティグループの名前
        }
    ] }

 

Description

poolに対してのヘルスモニタの関連付けを解除します。
poolにmemberが紐付いている場合には関連付けは解除ができませんので、解除する前に対象のpoolからmemberを全て削除する必要があります。

Request URL

Network API v2.0
DELETE /v2.0/lb/pools/{pool_id}/health_monitors/{health_monitor_id}

Request Json

This operation does not accept a request body.

Request Paramters

Parameter Value Style Description
X-Auth-Token Userトークン header トークンID
pool_id プールID URI プールIDを指定します。
health_monitor_id ヘルスモニタID URI ヘルスモニタIDを指定します。

Response

Normal response codes

204

Example

Request

curl -i -X DELETE \
-H “Accept: application/json” \
-H “X-Auth-Token: トークンID” \
https://networking.odc01.eva-clouds.com/v2.0/lb/pools/プールID/health_monitors/ヘルスモニタID

Response

HTTP/1.1 204 No Content
Date: Mon, 11 Jul 2016 07:36:29 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json