Auto Scale - Super OCN Flexible Connect API リファレンス (1.0)

Download OpenAPI specification:Download

概要

本APIでは、 Super OCN Flexible Connect が提供するリソースの参照・操作が可能です。

autoscale-circuits-configs

全契約回線のAutoscaleコンフィグ取得

契約している全回線のAutoscaleコンフィグを取得する

path Parameters
tenantId
required
string
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/tenants/{tenantId}/autoscale/circuits
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/autoscale/circuits

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    },
  • {
    }
]

指定回線のAutoscaleコンフィグ取得

契約回線のAutoscaleコンフィグを取得する

path Parameters
circuitId
required
string
tenantId
required
string
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "circuitId": "ox0000000001",
  • "maxBandwidth": "700M",
  • "minBandwidth": "200M",
  • "ruleType": "custom",
  • "autoscaleRules":
    [
    ]
}

指定回線のAutoscaleコンフィグ修正

契約回線のAutoscaleコンフィグを修正する

path Parameters
circuitId
required
string
tenantId
required
string
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

・request body で指定しない要素は変更されない。

・daysOfWeek, dateFrom, dateTo, timeFrom, timeTo を指定なしに変更する場合は明示的に null を指定する。

ruleType
string
Enum: "custom" "predefined-50" "predefined-40" "predefined-70" "None"

Autoscale ルール種別.

  • None: Autoscale ルールを設定しない
  • Custom: ユーザ定義の Autoscale ルールを設定する
  • predefined-40: トラフィック量が指定帯域の40%を維持するように Autoscale を実行する
  • predefined-50: トラフィック量が指定帯域の50%を維持するように Autoscale を実行する
  • predefined-70: トラフィック量が指定帯域の70%を維持するように Autoscale を実行する
maxBandwidth
string

Autoscale ルールで action を up に指定した場合に autoscale によって変更できる最大帯域

minBandwidth
string

Autoscale ルールで action を down に指定した場合に autoscale によって変更できる最小帯域

autoscaleRules
Array of objects (AutoscaleRulePutRequestInConfig)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "ruleType": "custom",
  • "autoscaleRules":
    [
    ]
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "circuitId": "ox0000000001",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "ruleType": "custom",
  • "maxBandwidth": "700M",
  • "minBandwidth": "200M",
  • "autoscaleRules":
    [
    ]
}

autoscale-rules

指定回線のAutoscaleルール追加

契約回線のAutoscaleルールを一つ追加する(ルールタイプがcustomの時のみ適用可能)

path Parameters
circuitId
required
string
tenantId
required
string
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
customerNote
required
string <= 64 characters

顧客が任意で付与できる識別子(全角・半角・記号許容)

enable
required
boolean
Default: true

ルールの有効/無効

ruleIndex
required
integer [ 1 .. 10 ]

ルールの優先度. 1が最優先

metric
required
string
Value: "traffic-trend-5min"

Autoscale動作に用いる指標

threshold
required
integer [ 0 .. 100 ]

Autoscale 適用のしきい値

dataPoints
required
integer [ 6 .. 12 ]

Autoscale 適用条件を満たすための回数

comparison
required
string
Enum: "higher" "lower"

トラフィック量がしきい値を上回るか下回るかのどちらで autoscale を適用するかの指定

action
required
string
Enum: "up" "down" "alert" "10M" "20M" "30M" "40M" "50M" "60M" "70M" "80M" "90M" "100M" "200M" "300M" "400M" "500M" "600M" "700M" "800M" "900M" "1G" "2G" "3G" "4G" "5G" "6G" "7G" "8G" "9G" "10G" "20G" "30G" "40G" "50G" "60G" "70G" "80G" "90G" "100G"

Autoscale 適用条件を満たしたときの処理.

  • up/down: 設定帯域を1段階上げる/下げる
  • alert: メール通知
  • 帯域指定: 設定帯域をこの値に変更
daysOfWeek
Array of strings Nullable
Items Enum: "Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat"

曜日指定

dateFrom
string <date> Nullable

日付指定

dateTo
string <date> Nullable

日付指定

timeFrom
string Nullable ^\d{2}:\d{2}$

時間指定. 指定しない場合は 0:00 を示す

timeTo
string Nullable ^\d{2}:\d{2}$

時間指定. 指定しない場合は 23:59 を示す

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}/rules
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}/rules

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "customerNote": "オートスケールA",
  • "ruleIndex": 1,
  • "enable": true,
  • "action": "up",
  • "metric": "traffic-trend-5min",
  • "threshold": 70,
  • "dataPoints": 6,
  • "comparison": "higher",
  • "daysOfWeek":
    [
    ],
  • "dateFrom": "2018-08-27",
  • "dateTo": "2021-04-04",
  • "timeFrom": "09:30",
  • "timeTo": "17:30"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "customerNote": "オートスケールA",
  • "enable": true,
  • "ruleIndex": 1,
  • "metric": "traffic-trend-5min",
  • "threshold": 70,
  • "dataPoints": 6,
  • "comparison": "higher",
  • "action": "up",
  • "daysOfWeek":
    [
    ],
  • "dateFrom": "2018-08-27",
  • "dateTo": "2021-04-04",
  • "timeFrom": "09:30",
  • "timeTo": "17:30"
}

指定回線のAutoscaleルールを一つ取得

契約回線の指定した番号のAutoscaleルールを取得する

path Parameters
circuitId
required
string
tenantId
required
string
ruleId
required
string
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}/rules/{ruleId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/autoscale/circuits/{circuitId}/rules/{ruleId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
  • "customerNote": "オートスケールA",
  • "enable": true,
  • "ruleIndex": 1,
  • "metric": "traffic-trend-5min",
  • "threshold": 70,
  • "dataPoints": 6,
  • "comparison": "higher",
  • "action": "up",
  • "daysOfWeek":
    [
    ],
  • "dateFrom": "2018-08-27",
  • "dateTo": "2021-04-04",
  • "timeFrom": "09:30",
  • "timeTo": "17:30"
}

指定回線のAutoscaleルールを一つ修正

契約回線の指定した番号のAutoscaleルールを書き換える

path Parameters
circuitId
required
string
tenantId
required
string
ruleId
required
string
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

・request body で指定しない要素は変更されない。

・daysOfWeek, dateFrom, dateTo, timeFrom, timeTo を指定なしに変更する場合は明示的に null を指定する。

customerNote
string <= 64 characters

顧客が任意で付与できる識別子(全角・半角・記号許容)

enable