Auto Scale - Super OCN Flexible Connect API リファレンス (1.0)
Download OpenAPI specification:Download
全契約回線のAutoscaleコンフィグ取得
契約している全回線のAutoscaleコンフィグを取得する
path Parameters
tenantId required | string |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
[- {
- "circuitId": "ox0000000001",
- "ruleType": "custom",
- "maxBandwidth": "700M",
- "minBandwidth": "200M",
- "autoscaleRules": [
- {
- "ruleId": "794437c066d711eca521acde48001122",
- "customerNote": "オートスケールA",
- "enable": true,
- "ruleIndex": 1,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2023-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
]
}, - {
- "circuitId": "ox0000000002",
- "ruleType": "predefined-40"
}
]
指定回線のAutoscaleコンフィグ取得
契約回線のAutoscaleコンフィグを取得する
path Parameters
circuitId required | string |
tenantId required | string |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
{- "circuitId": "ox0000000001",
- "maxBandwidth": "700M",
- "minBandwidth": "200M",
- "ruleType": "custom",
- "autoscaleRules": [
- {
- "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
- "customerNote": "オートスケールA",
- "enable": true,
- "ruleIndex": 1,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
]
}
指定回線の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 ルール種別.
|
maxBandwidth | string Autoscale ルールで action を up に指定した場合に autoscale によって変更できる最大帯域 |
minBandwidth | string Autoscale ルールで action を down に指定した場合に autoscale によって変更できる最小帯域 |
autoscaleRules | Array of objects (AutoscaleRulePutRequestInConfig) |
Responses
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "ruleType": "custom",
- "autoscaleRules": [
- {
- "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
- "customerNote": "オートスケールB",
- "enable": true,
- "ruleIndex": 3,
- "metric": "traffic-trend-5min",
- "threshold": 60,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}, - {
- "ruleId": "0add76be1dc74171a0999c912c865bde",
- "cutomerNote": "オートスケールC",
- "enable": true,
- "ruleIndex": 2,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
]
}
Response samples
- 202
{- "circuitId": "ox0000000001",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "ruleType": "custom",
- "maxBandwidth": "700M",
- "minBandwidth": "200M",
- "autoscaleRules": [
- {
- "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
- "customerNote": "オートスケールB",
- "enable": true,
- "ruleIndex": 3,
- "metric": "traffic-trend-5min",
- "threshold": 60,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}, - {
- "ruleId": "0add76be1dc74171a0999c912c865bde",
- "customerNote": "オートスケールC",
- "enable": true,
- "ruleIndex": 2,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
]
}
指定回線の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 適用条件を満たしたときの処理.
|
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
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "customerNote": "オートスケールA",
- "ruleIndex": 1,
- "enable": true,
- "action": "up",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Response samples
- 202
{- "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "customerNote": "オートスケールA",
- "enable": true,
- "ruleIndex": 1,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "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
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
{- "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
- "customerNote": "オートスケールA",
- "enable": true,
- "ruleIndex": 1,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "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 | boolean Default: true ルールの有効/無効 |
ruleIndex | integer [ 1 .. 10 ] ルールの優先度. 1が最優先 |
metric | string Value: "traffic-trend-5min" Autoscale動作に用いる指標 |
threshold | integer [ 0 .. 100 ] Autoscale 適用のしきい値 |
dataPoints | integer [ 6 .. 12 ] Autoscale 適用条件を満たすための回数 |
comparison | string Enum: "higher" "lower" トラフィック量がしきい値を上回るか下回るかのどちらで autoscale を適用するかの指定 |
action | 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 適用条件を満たしたときの処理.
|
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
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "customerNote": "オートスケールA",
- "enable": true,
- "ruleIndex": 1,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Response samples
- 202
{- "ruleId": "70af307165d94ec3b3cb5283e8d55dac",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "customerNote": "オートスケールA",
- "enable": true,
- "ruleIndex": 1,
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "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 | string クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 202
{- "ruleId": "794437c066d711eca521acde48001122",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf"
}
全てのAutoscaleテンプレートを取得
全てのテンプレートを取得する
path Parameters
tenantId required | string |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
[- {
- "templateId": "196100ac4eec4fb6a7f786c8b584771d",
- "customerNote": "オートスケールA",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}, - {
- "templateId": "355381f302ff46c691a866182ec81abc",
- "customerNote": "オートスケールB",
- "metric": "traffic-trend-5min",
- "threshold": 30,
- "dataPoints": 6,
- "comparison": "lower",
- "action": "down",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
]
Autoscaleテンプレートを作成
Autoscaleテンプレートを作成する
path Parameters
tenantId required | string |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
customerNote required | string <= 64 characters 顧客が任意で付与できる識別子(全角・半角・記号許容) |
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 適用条件を満たしたときの処理.
|
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
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "customerNote": "オートスケールA",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Response samples
- 202
{- "templateId": "196100ac4eec4fb6a7f786c8b584771d",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "customerNote": "オートスケールA",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Autoscaleテンプレートを取得する
指定した番号のAutoscaleテンプレートを取得する
path Parameters
tenantId required | string |
templateId required | string |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
{- "templateId": "196100ac4eec4fb6a7f786c8b584771d",
- "customerNote": "オートスケールA",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Autoscaleテンプレートを修正する
指定した番号のAutoscaleテンプレートを修正する
path Parameters
tenantId required | string |
templateId 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 顧客が任意で付与できる識別子(全角・半角・記号許容) |
metric | string Value: "traffic-trend-5min" Autoscale動作に用いる指標 |
threshold | integer [ 0 .. 100 ] Autoscale 適用のしきい値 |
dataPoints | integer [ 6 .. 12 ] Autoscale 適用条件を満たすための回数 |
comparison | string Enum: "higher" "lower" トラフィック量がしきい値を上回るか下回るかのどちらで autoscale を適用するかの指定 |
action | 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 適用条件を満たしたときの処理.
|
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
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "customerNote": "オートスケールA",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Response samples
- 202
{- "templateId": "196100ac4eec4fb6a7f786c8b584771d",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "customerNote": "オートスケールA",
- "metric": "traffic-trend-5min",
- "threshold": 70,
- "dataPoints": 6,
- "comparison": "higher",
- "action": "up",
- "daysOfWeek": [
- "Sun"
], - "dateFrom": "2018-08-27",
- "dateTo": "2021-04-04",
- "timeFrom": "09:30",
- "timeTo": "17:30"
}
Autoscaleテンプレートを削除する
指定した番号のAutoscaleテンプレートを削除する
path Parameters
tenantId required | string |
templateId required | string |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 202
{- "templateId": "3406204a66d911eca521acde48001122",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf"
}