openapi: 3.2.0
info:
title: Sakura Internet セキュリティ API
x-refined-note:
- x-logo differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged セキュリティ across 24 of this provider''s published API definitions: addon-api.yaml, apigw-api.yaml, apprun-shared-api.yaml, monitoring-suite-api.yaml, networking-suite-api.yaml, nosql-api.yaml, objectstorage-api.yaml, phy-api-original-swagger.json, security-control-api.yaml, seg-api.yaml, simple-notification-api.yaml, workflows-api.yaml, sakura-internet-addon-openapi.yml, sakura-internet-apigw-openapi.yml, sakura-internet-apprun-shared-openapi.yml…'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/securitycontrol/1.0/
description: さくらのクラウド セキュリティコントロール エンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1
description: さくらのクラウド(石狩第2ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウド(石狩第1ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1
description: さくらのクラウド(サンドボックスゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1
description: さくらのクラウド(東京第1ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
tags:
- name: セキュリティ
paths:
/security/ddos:
get:
tags:
- セキュリティ
summary: DDoS対策サービスリソースの一覧を取得します。
description: アドオンのDDoS対策サービスリソースの一覧を取得します。
operationId: list_AZ0401
responses:
'200':
description: DDoS対策サービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: DDoS対策サービスリソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: DDoS対策サービスリソースを作成します。
description: アドオンのDDoS対策サービスリソースを作成します。
operationId: create_AZ0401
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DdosRequestBody'
required: true
responses:
'202':
description: DDoS対策サービスリソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/ddos/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定されたDDoS対策サービスリソースを取得します。
description: アドオンの指定されたDDoS対策サービスリソースを取得します。
operationId: get_AZ0401
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: DDoS対策サービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: DDoS対策サービスリソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定されたDDoS対策サービスリソースを削除します。
description: アドオンの指定されたDDoS対策サービスリソースを削除します。
operationId: delete_AZ0401
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: DDoS対策サービスリソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: DDoS対策サービスリソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/ddos/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたDDoS対策サービスリソースのステータスを取得します。
description: アドオンの指定されたDDoS対策サービスリソースのステータスを取得します。
operationId: status_AZ0401
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
- name: deploymentName
in: path
description: デプロイメント名
required: true
schema:
type: string
responses:
'200':
description: DDoS対策サービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/waf:
get:
tags:
- セキュリティ
summary: WAFサービスリソースの一覧を取得します。
description: アドオンのWAFサービスリソースの一覧を取得します。
operationId: list_AZ0402
responses:
'200':
description: WAFサービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: WAFサービスリソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: WAFサービスリソースを作成します。
description: アドオンのWAFサービスリソースを作成します。
operationId: create_AZ0402
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WafRequestBody'
required: true
responses:
'202':
description: WAFサービスリソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/waf/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定されたWAFサービスリソースを取得します。
description: アドオンの指定されたWAFサービスリソースを取得します。
operationId: get_AZ0402
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: WAFサービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: WAFサービスリソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定されたWAFサービスリソースを削除します。
description: アドオンの指定されたWAFサービスリソースを削除します。
operationId: delete_AZ0402
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: WAFサービスリソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: WAFサービスリソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/waf/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたWAFサービスリソースのステータスを取得します。
description: アドオンの指定されたWAFサービスリソースのステータスを取得します。
operationId: status_AZ0402
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
- name: deploymentName
in: path
description: デプロイメント名
required: true
schema:
type: string
responses:
'200':
description: WAFサービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/vulnerability:
get:
tags:
- セキュリティ
summary: 脆弱性検出サービスリソースの一覧を取得します。
description: アドオンの脆弱性検出サービスリソースの一覧を取得します。
operationId: list_AZ0403
responses:
'200':
description: 脆弱性検出サービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 脆弱性検出サービスリソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: 脆弱性検出サービスのインストールスクリプトを発行します。
description: アドオンの脆弱性検出サービスリソースを作成します。脆弱性検出サービスを利用するためには、レスポンスに含まれるインストールスクリプトを対象のVMで実行しエージェントをインストールする必要があります。
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VulnerabilityRequestBody'
required: true
responses:
'202':
description: 脆弱性検出サービスのインストールスクリプトを発行しました。
content:
application/json:
schema:
$ref: '#/components/schemas/VulnerabilityResponseBody'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: postSecurityVulnerability
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/security/vulnerability/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定された脆弱性検出サービスリソースを取得します。
description: アドオンの指定された脆弱性検出サービスリソースを取得します。
operationId: get_AZ0403
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: 脆弱性検出サービスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 脆弱性検出サービスリソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定された脆弱性検出サービスリソースを削除します。
description: アドオンの指定された脆弱性検出サービスリソースを削除します。
operationId: delete_AZ0403
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: 脆弱性検出サービスリソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 脆弱性検出サービスリソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/datalake:
get:
tags:
- セキュリティ
summary: データレイクリソースの一覧を取得します。
description: アドオンのデータレイクリソースの一覧を取得します。
operationId: list_AZ0101
responses:
'200':
description: データレイクリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データレイクリソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: データレイクリソースを作成します。
description: アドオンのデータレイクリソースを作成します。
operationId: create_AZ0101
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatalakePostRequestBody'
required: true
responses:
'202':
description: データレイクリソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/datalake/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定されたデータレイクリソースを取得します。
description: アドオンの指定されたデータレイクリソースを取得します。
operationId: get_AZ0101
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: データレイクリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データレイクリソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定されたデータレイクリソースを削除します。
description: アドオンの指定されたデータレイクリソースを削除します。
operationId: delete_AZ0101
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: データレイクリソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データレイクリソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/datalake/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたデータレイクリソースのステータスを取得します。
description: アドオンの指定されたデータレイクリソースのステータスを取得します。
operationId: status_AZ0101
parameters:
- name: resourceGroupName
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
responses:
'200':
description: データレイクリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/dwh:
get:
tags:
- セキュリティ
summary: データウェアハウスリソースの一覧を取得します。
description: アドオンのデータウェアハウスリソースの一覧を取得します。
operationId: list_AZ0102
responses:
'200':
description: データウェアハウスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データウェアハウスリソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: データウェアハウスリソースを作成します。
description: アドオンのデータウェアハウスリソースを作成します。
operationId: create_AZ0102
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatawarehousePostRequestBody'
required: true
responses:
'202':
description: データウェアハウスリソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/dwh/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定されたデータウェアハウスリソースを取得します。
description: アドオンの指定されたデータウェアハウスリソースを取得します。
operationId: get_AZ0102
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: データウェアハウスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データウェアハウスリソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定されたデータウェアハウスリソースを削除します。
description: アドオンの指定されたデータウェアハウスリソースを削除します。
operationId: delete_AZ0102
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: データウェアハウスリソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データウェアハウスリソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/dwh/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたデータウェアハウスリソースのステータスを取得します。
description: アドオンの指定されたデータウェアハウスリソースのステータスを取得します。
operationId: status_AZ0102
parameters:
- name: resourceGroupName
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
responses:
'200':
description: データウェアハウスリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/etl:
get:
tags:
- セキュリティ
summary: データETLリソースの一覧を取得します。
description: アドオンのデータETLリソースの一覧を取得します。
operationId: list_AZ0103
responses:
'200':
description: データETLリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データETLリソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: データETLリソースを作成します。
description: アドオンのデータETLリソースを作成します。
operationId: create_AZ0103
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EtlPostRequestBody'
required: true
responses:
'202':
description: データETLリソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/etl/{resourceGroupName}:
delete:
tags:
- セキュリティ
summary: 指定されたデータETLリソースを削除します。
description: アドオンの指定されたデータETLリソースを削除します。
operationId: delete_AZ0103
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: データETLリソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データETLリソースが見つかりませんでした。
get:
tags:
- セキュリティ
summary: 指定されたデータETLリソースを取得します。
description: アドオンの指定されたデータETLリソースを取得します。
operationId: get_AZ0103
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: データETLリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: データETLリソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/etl/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたデータETLリソースのステータスを取得します。
description: アドオンの指定されたデータETLリソースのステータスを取得します。
operationId: status_AZ0103
parameters:
- name: resourceGroupName
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
responses:
'200':
description: データETLリソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/query:
get:
tags:
- セキュリティ
summary: クエリ機能リソースの一覧を取得します。
description: アドオンのクエリ機能リソースの一覧を取得します。
operationId: list_AZ0104
responses:
'200':
description: クエリ機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: クエリ機能リソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: クエリ機能リソースを作成します。
description: アドオンのクエリ機能リソースを作成します。
operationId: create_AZ0104
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryPostRequestBody'
required: true
responses:
'202':
description: クエリ機能リソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/query/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定されたクエリ機能リソースを取得します。
description: アドオンの指定されたクエリ機能リソースを取得します。
operationId: get_AZ0104
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: クエリ機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: クエリ機能リソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定されたクエリ機能リソースを削除します。
description: アドオンの指定されたクエリ機能リソースを削除します。
operationId: delete_AZ0104
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: クエリ機能リソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: クエリ機能リソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/query/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたクエリ機能リソースのステータスを取得します。
description: アドオンの指定されたクエリ機能リソースのステータスを取得します。
operationId: status_AZ0104
parameters:
- name: resourceGroupName
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
responses:
'200':
description: クエリ機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/search:
get:
tags:
- セキュリティ
summary: 検索機能リソースの一覧を取得します。
description: アドオンの検索機能リソースの一覧を取得します。
operationId: list_AZ0105
responses:
'200':
description: 検索機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 検索機能リソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: 検索機能リソースを作成します。
description: アドオンの検索機能リソースを作成します。
operationId: create_AZ0105
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchPostRequestBody'
required: true
responses:
'202':
description: 検索機能リソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/search/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定された検索機能リソースを取得します。
description: アドオンの指定された検索機能リソースを取得します。
operationId: get_AZ0105
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: 検索機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 検索機能リソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定された検索機能リソースを削除します。
description: アドオンの指定された検索機能リソースを削除します。
operationId: delete_AZ0105
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: 検索機能リソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: 検索機能リソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/search/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定された検索機能リソースのステータスを取得します。
description: アドオンの指定された検索機能リソースのステータスを取得します。
operationId: status_AZ0105
parameters:
- name: resourceGroupName
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
responses:
'200':
description: 検索機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/streaming:
get:
tags:
- セキュリティ
summary: ストリーミング処理機能リソースの一覧を取得します。
description: アドオンのストリーミング処理機能リソースの一覧を取得します。
operationId: list_AZ0107
responses:
'200':
description: ストリーミング処理機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: ストリーミング処理機能リソースが見つかりませんでした。
post:
tags:
- セキュリティ
summary: ストリーミング処理機能リソースを作成します。
description: アドオンのストリーミング処理機能リソースを作成します。
operationId: create_AZ0107
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreamingRequestBody'
required: true
responses:
'202':
description: ストリーミング処理機能リソースの作成を開始しました。
content:
application/json:
schema:
$ref: '#/components/schemas/PostDeploymentResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/streaming/{resourceGroupName}:
get:
tags:
- セキュリティ
summary: 指定されたストリーミング処理機能リソースを取得します。
description: アドオンの指定されたストリーミング処理機能リソースを取得します。
operationId: get_AZ0107
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'200':
description: ストリーミング処理機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourceResponse'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: ストリーミング処理機能リソースが見つかりませんでした。
delete:
tags:
- セキュリティ
summary: 指定されたストリーミング処理機能リソースを削除します。
description: アドオンの指定されたストリーミング処理機能リソースを削除します。
operationId: delete_AZ0107
parameters:
- name: resourceGroupName
in: path
description: リソースグループ名
required: true
schema:
type: string
responses:
'204':
description: ストリーミング処理機能リソースの削除を開始しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: ストリーミング処理機能リソースが見つかりませんでした。
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/analytics/streaming/status/{resourceGroupName}/{deploymentName}:
get:
tags:
- セキュリティ
summary: 指定されたストリーミング処理機能リソースのステータスを取得します。
description: アドオンの指定されたストリーミング処理機能リソースのステータスを取得します。
operationId: status_AZ0107
parameters:
- name: resourceGroupName
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
responses:
'200':
description: ストリーミング処理機能リソースの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/addon/1.0/
/groups:
get:
tags:
- セキュリティ
summary: Group一覧照会API
description: 登録した Group の一覧を取得します。
operationId: getGroups
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
groups:
type: array
items:
$ref: '#/components/schemas/Group'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
post:
tags:
- セキュリティ
summary: Group登録API
description: '新しい Group を登録します。
Group は User を分類し、アクセス制御を管理するために使用されます。'
operationId: addGroup
requestBody:
description: Create a Group
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
group:
$ref: '#/components/schemas/Group'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/groups/{groupId}:
get:
tags:
- セキュリティ
summary: Group詳細照会API
description: 登録した Group の詳細情報を取得します。
operationId: getGroup
parameters:
- $ref: '#/components/parameters/GroupID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
group:
$ref: '#/components/schemas/Group'
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: Group更新API
description: 登録した Group の詳細情報を更新します。
operationId: updateGroup
parameters:
- $ref: '#/components/parameters/GroupID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: Group削除API
description: 登録した Group を削除します。
operationId: deleteGroup
parameters:
- $ref: '#/components/parameters/GroupID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/subscriptions:
post:
tags:
- セキュリティ
summary: 契約API
description: 選択したプランで API Gateway の利用契約を行います。
operationId: subscribe
requestBody:
description: 契約情報
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionCreate'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: 契約一覧照会API
description: お客様の API Gateway 契約情報の一覧を取得します。
operationId: getSubscriptions
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
$ref: '#/components/schemas/SubscriptionList'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
operationId: deleteSubscription
summary: ワークフローの課金プランの削除をする
tags:
- セキュリティ
parameters: []
responses:
'204':
description: ワークフローのプラン削除に成功した
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/subscriptions/{subscriptionId}:
get:
tags:
- セキュリティ
summary: 契約詳細照会API
description: 'お客様の API Gateway 契約情報を取得します。
契約が存在する場合は、契約情報と利用中のプラン情報を返却します。'
operationId: getSubscriptionById
parameters:
- $ref: '#/components/parameters/SubscriptionID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
subscription:
$ref: '#/components/schemas/SubscriptionDetailResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: 契約更新API
description: 契約名を更新します。
operationId: updateSubscription
parameters:
- $ref: '#/components/parameters/SubscriptionID'
requestBody:
description: 契約情報
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionUpdate'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: 契約解約API
description: 登録した契約を解約します。
operationId: unsubscribe
parameters:
- $ref: '#/components/parameters/SubscriptionID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services:
post:
tags:
- セキュリティ
summary: Service登録API
description: アップストリームのエンドポイント情報である Service を登録します。
operationId: addService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceDetailRequest'
required: true
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
service:
$ref: '#/components/schemas/ServiceDetailRequest'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'422':
$ref: '#/components/responses/UnprocessableEntityResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Service一覧照会API
description: 登録した Service の一覧を取得します。
operationId: getServices
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
properties:
services:
type: array
items:
$ref: '#/components/schemas/ServiceDetailResponse'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services/{serviceId}:
get:
tags:
- セキュリティ
summary: Service詳細照会API
description: 登録した Service の詳細情報を取得します。
operationId: getServiceById
parameters:
- $ref: '#/components/parameters/ServiceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
service:
$ref: '#/components/schemas/ServiceDetailResponse'
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: Service更新API
description: 登録した Service の詳細情報を更新します。
operationId: updateService
parameters:
- $ref: '#/components/parameters/ServiceID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceDetail'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: Service削除API
description: 登録した Service を削除します。
operationId: deleteService
parameters:
- $ref: '#/components/parameters/ServiceID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services/{serviceId}/routes:
post:
tags:
- セキュリティ
summary: Route登録API
description: '登録した Service に対して、公開するエンドポイントとして Route を登録します。
各 Route の認証設定は全て Service の設定に準じます。'
operationId: addRoute
parameters:
- $ref: '#/components/parameters/ServiceID'
requestBody:
description: Create a route
content:
application/json:
schema:
$ref: '#/components/schemas/RouteDetail'
required: true
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
properties:
route:
$ref: '#/components/schemas/RouteDetail'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Service Route一覧照会API
description: Service に登録した Route の一覧を取得します。
operationId: getServiceRoutes
parameters:
- $ref: '#/components/parameters/ServiceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
properties:
routes:
type: array
items:
$ref: '#/components/schemas/Route'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services/{serviceId}/routes/{routeId}:
get:
tags:
- セキュリティ
summary: Route詳細照会API
description: Service に登録した Route の詳細情報を取得します。
operationId: getRoute
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
required:
- apigw
properties:
apigw:
properties:
route:
$ref: '#/components/schemas/RouteDetail'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: Route更新API
description: Service に登録した Route の詳細情報を更新します。
operationId: updateRoute
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
requestBody:
description: Update a route
content:
application/json:
schema:
$ref: '#/components/schemas/RouteDetail'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: Route削除API
description: Service に登録した Route を削除します。
operationId: deleteRoute
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services/{serviceId}/routes/{routeId}/authorization:
put:
tags:
- セキュリティ
summary: Route認可情報更新API
description: '登録した Route に対してアクセス可能な Group を登録します。
登録しない場合は全てのUserがアクセス可能になります。'
operationId: upsertRouteAuthorization
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RouteAuthorizationDetail'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Route認可情報取得API
description: Route に登録した認可情報を取得します。
operationId: getRouteAuthorization
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
required:
- apigw
properties:
apigw:
properties:
routeAuthorization:
$ref: '#/components/schemas/RouteAuthorizationDetailResponse'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services/{serviceId}/routes/{routeId}/request:
put:
tags:
- セキュリティ
summary: Route Request変換情報更新API
description: 'Route から Service へ転送する際にリクエスト内容を変換する設定を登録します。
- **httpMethod**: 設定したHTTPメソッドへ変換します。
- **allow**: 設定した Key 以外をリクエストから取り除きます。
- **remove**: 設定した Key をリクエストから取り除きます。
- **rename**: 設定した From-To に従い、リクエストの Key を変更します。
- **replace**: 設定した Key と同名の Key がリクエストに存在する場合、Value の値を置換します。
- **add**: 設定した値をリクエストに追加します。同名の Key がリクエストに存在しない場合に機能します。
- **append**: 設定した値をリクエストに追加します。同名の Key がリクエストに存在する場合は Value に追記します。'
operationId: upsertRequestTransformation
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTransformation'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Route Request変換情報取得API
description: Route に登録したリクエスト変換情報を取得します。
operationId: getRequestTransformation
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
required:
- apigw
properties:
apigw:
properties:
requestTransformation:
$ref: '#/components/schemas/RequestTransformation'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/services/{serviceId}/routes/{routeId}/response:
put:
tags:
- セキュリティ
summary: Route Response変換情報更新API
description: 'Route から Service へ転送する際にレスポンス内容を変換する設定を登録します。
- **allow**: 設定した Key 以外をレスポンスから取り除きます。
- **remove**: 設定した Key をレスポンスから取り除きます。
- **rename**: 設定した From-To に従い、レスポンスの Key を変更します。
- **replace**: 設定した Key と同名の Key がレスポンスに存在する場合、Value の値を置換します。
- **add**: 設定した値をレスポンスに追加します。同名の Key がレスポンスに存在しない場合に機能します。
- **append**: 設定した値をレスポンスに追加します。同名の Key がレスポンスに存在する場合は Value に追記します。
- **ifStatusCode**: 設定した場合、アップストリームからのレスポンスコードが設定した値と一致する場合に、各種変換が機能します。'
operationId: upsertResponseTransformation
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseTransformation'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Route Response変換情報取得API
description: Route に登録したレスポンス変換情報を取得します。
operationId: getResponseTransformation
parameters:
- $ref: '#/components/parameters/ServiceID'
- $ref: '#/components/parameters/RouteID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
required:
- apigw
properties:
apigw:
properties:
responseTransformation:
$ref: '#/components/schemas/ResponseTransformation'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/domains:
post:
tags:
- セキュリティ
summary: Domain登録API
description: route の host で使用するドメインを登録します。
operationId: addDomain
requestBody:
description: Create a Domain
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
required: true
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
domain:
$ref: '#/components/schemas/Domain'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Domain一覧照会API
description: 登録した Domain の一覧を取得します。
operationId: getDomains
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties: null
$ref: '#/components/schemas/DomainDTO'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/domains/{domainId}:
put:
tags:
- セキュリティ
summary: Domain更新API
description: '登録した Domain の証明書情報を更新します。
ドメイン名の変更はできません。'
operationId: updateDomain
parameters:
- $ref: '#/components/parameters/DomainID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainPUT'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: Domain削除API
description: 登録した Domain を削除します。
operationId: deleteDomain
parameters:
- $ref: '#/components/parameters/DomainID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/plans:
get:
tags:
- セキュリティ
summary: プラン一覧照会API
description: 現在契約可能な API Gateway の料金プランの一覧を取得します。
operationId: getPlans
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
properties:
plans:
type: array
items:
$ref: '#/components/schemas/Plan'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/users:
post:
tags:
- セキュリティ
summary: User登録API
description: '認証情報を設定する User を登録します。
User のIP制限設定は、Route にIP制限が設定されていない場合に機能します。'
operationId: addUser
requestBody:
description: Create a User
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetail'
required: true
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
user:
$ref: '#/components/schemas/UserDetail'
'400':
$ref: '#/components/responses/BadRequestResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: User一覧照会API
description: 登録した User の一覧を取得します。
operationId: getUsers
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
users:
type: array
items:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/users/{userId}:
get:
tags:
- セキュリティ
summary: User詳細照会API
description: 登録した User の詳細情報を取得します。
operationId: getUser
parameters:
- $ref: '#/components/parameters/UserID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
user:
$ref: '#/components/schemas/UserDetail'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: User更新API
description: 登録した User の詳細情報を更新します。
operationId: updateUser
parameters:
- $ref: '#/components/parameters/UserID'
requestBody:
description: Update a user
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetail'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: User削除API
description: 登録した User を削除します。
operationId: deleteUser
parameters:
- $ref: '#/components/parameters/UserID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/users/{userId}/groups:
get:
tags:
- セキュリティ
summary: User所属Group照会API
description: '登録した Group の一覧を取得します。
指定した User が各 Group に所属しているかどうかの情報も含めて返却します。'
operationId: getUserGroup
parameters:
- $ref: '#/components/parameters/UserID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
groups:
type: array
items:
$ref: '#/components/schemas/UserGroupDetail'
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: User所属Group更新API
description: 登録した User を Group に所属させます。
operationId: updateUserGroup
parameters:
- $ref: '#/components/parameters/UserID'
requestBody:
description: Update a user group
content:
application/json:
schema:
items:
$ref: '#/components/schemas/UserGroupDetailUpdate'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/users/{userId}/authentication:
get:
tags:
- セキュリティ
summary: User認証情報取得API
description: 'User に登録された認証情報を取得します。
なお、パスワード、シークレットなどの機密情報は取得できません。'
operationId: getUserAuthentication
parameters:
- $ref: '#/components/parameters/UserID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
userAuthentication:
$ref: '#/components/schemas/UserAuthentication'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
put:
tags:
- セキュリティ
summary: User認証情報更新API
description: User に認証情報を登録します。
operationId: upsertUserAuthentication
parameters:
- $ref: '#/components/parameters/UserID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserAuthentication'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/certificates:
post:
tags:
- セキュリティ
summary: Certificate登録API
description: SSL証明書を登録します。
operationId: addCertificate
requestBody:
description: Create a Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
required: true
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
type: object
properties:
certificate:
$ref: '#/components/schemas/Certificate'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
get:
tags:
- セキュリティ
summary: Certificate一覧照会API
description: 登録した Certificate の一覧を取得します。
operationId: getCertificates
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
type: object
required:
- apigw
properties:
apigw:
$ref: '#/components/schemas/GetCertificates'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/certificates/acme:
post:
tags:
- セキュリティ
summary: AutoCertificate発行 API
description: 証明書を自動発行します。
operationId: postCertificatesAcme
requestBody:
description: 証明書情報
content:
application/json:
schema:
$ref: '#/components/schemas/CertificatesAcme'
required: true
responses:
'202':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/certificates/{certificateId}:
put:
tags:
- セキュリティ
summary: Certificate更新API
description: 登録した Certificate の詳細情報を更新します。
operationId: updateCertificate
parameters:
- $ref: '#/components/parameters/CertificateID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
required: true
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'422':
$ref: '#/components/responses/UnprocessableEntityResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
delete:
tags:
- セキュリティ
summary: Certificate削除API
description: 登録した Certificate を削除します。
operationId: deleteCertificate
parameters:
- $ref: '#/components/parameters/CertificateID'
responses:
'204':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/certificates/{certificateId}/acme/renew:
post:
tags:
- セキュリティ
summary: AutoCertificate有効期限更新 API
description: 自動発行の証明書有効期限を更新します。
operationId: certificatesAcmeRenew
parameters:
- $ref: '#/components/parameters/CertificateID'
responses:
'202':
description: 成功時の返却値はありません。
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/certificates/{certificateId}/acme/reissue:
post:
tags:
- セキュリティ
summary: AutoCertificate再発行 API
description: 証明書の識別名または証明書のSANに含めるドメインを更新します。
operationId: certificatesAcmeReissue
parameters:
- $ref: '#/components/parameters/CertificateID'
requestBody:
description: 証明書情報
content:
application/json:
schema:
$ref: '#/components/schemas/CertificatesAcme'
required: true
responses:
'202':
description: 成功時の返却値はありません。
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'409':
$ref: '#/components/responses/ConflictResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apigw/1.0/
/applications:
get:
operationId: listApplications
tags:
- セキュリティ
summary: アプリケーション一覧を取得します。
description: AppRun共用型のアプリケーション一覧を取得します。
parameters:
- in: query
name: page_num
schema:
type: integer
minimum: 1
default: 1
description: 表示したいページ番号
required: false
example: 20
- in: query
name: page_size
schema:
type: integer
minimum: 1
maximum: 100
default: 50
description: 表示したい1ページあたりのサイズ
required: false
example: 10
- in: query
name: sort_field
schema:
type: string
default: created_at
description: ソートしたいフィールド名
required: false
example: created_at
- in: query
name: sort_order
schema:
type: string
default: desc
enum:
- asc
- desc
description: ソート順(昇順、降順)
required: false
example: asc
responses:
'200':
description: アプリケーション一覧の取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.listApplications'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
post:
operationId: createApplication
tags:
- セキュリティ
summary: アプリケーションを作成します。
description: AppRun共用型にアプリケーションを作成します。
requestBody:
description: 作成するアプリケーションの情報を入力します。
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/createApplicationBody'
responses:
'201':
description: アプリケーションの作成に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.createApplication'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'409':
description: アプリケーションが重複し作成が失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}:
get:
operationId: readApplication
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーション詳細を取得します。
description: AppRun共用型のアプリケーション詳細を取得します。
responses:
'200':
description: アプリケーション詳細の取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.readApplication'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
patch:
operationId: patchApplication
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーションを部分的に変更します。
description: AppRun共用型のアプリケーションを部分的に変更します。
requestBody:
description: 部分的に変更するアプリケーションの情報を入力します。
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/patchApplicationBody'
responses:
'200':
description: アプリケーションの変更に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.patchApplication'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'409':
description: アプリケーションが重複し作成が失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
delete:
operationId: deleteApplication
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーションを削除します。
description: AppRun共用型のアプリケーションを削除します。
responses:
'204':
description: アプリケーションの削除に成功しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}/status:
get:
operationId: readApplicationStatus
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーションステータスを取得します。
description: AppRun共用型のアプリケーションステータスを取得します。
responses:
'200':
description: アプリケーションステータスの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.readApplicationStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}/traffics:
get:
operationId: listApplicationTraffic
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーショントラフィック分散を取得します。
description: AppRun共用型のアプリケーショントラフィック分散を取得します。
responses:
'200':
description: アプリケーショントラフィック分散の取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.listTraffic'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
put:
operationId: updateApplicationTraffic
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーショントラフィック分散を変更します。
description: AppRun共用型のアプリケーショントラフィック分散を変更します。
requestBody:
description: 'トラフィック分散の割合を入力します。
version_nameまたはis_latest_versionのどちらかを指定して何%の割合でトラフィックを転送するかを入力します。
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/updateTrafficBody'
responses:
'200':
description: アプリケーショントラフィック分散の変更に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.updateTraffic'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}/versions:
get:
operationId: listApplicationVersions
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: query
name: page_num
schema:
type: integer
minimum: 1
default: 1
description: 表示したいページ番号
required: false
example: 20
- in: query
name: page_size
schema:
type: integer
minimum: 1
maximum: 100
default: 50
description: 表示したい1ページあたりのサイズ
required: false
example: 10
- in: query
name: sort_field
schema:
type: string
default: created_at
description: ソートしたいフィールド名
required: false
example: created_at
- in: query
name: sort_order
schema:
type: string
default: desc
enum:
- asc
- desc
description: ソート順(昇順、降順)
required: false
example: asc
tags:
- セキュリティ
summary: アプリケーションバージョン一覧を取得します。
description: AppRun共用型のアプリケーションバージョン一覧を取得します。
responses:
'200':
description: アプリケーションバージョン一覧の取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.listVersions'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションバージョンが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}/versions/{version_id}:
get:
operationId: readApplicationVersion
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: path
name: version_id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーションバージョン詳細を取得します。
description: AppRun共用型のアプリケーションバージョン詳細を取得します。
responses:
'200':
description: アプリケーションバージョン詳細の取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.readVersion'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションバージョンが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
delete:
operationId: deleteApplicationVersion
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: path
name: version_id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーションバージョンを削除します。
description: AppRun共用型のアプリケーションバージョンを削除します。
responses:
'204':
description: アプリケーションバージョンの削除に成功しました。
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションバージョンが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}/versions/{version_id}/status:
get:
operationId: readApplicationVersionStatus
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: path
name: version_id
schema:
type: string
required: true
tags:
- セキュリティ
summary: アプリケーションバージョンステータスを取得します。
description: AppRun共用型のアプリケーションバージョンステータスを取得します。
responses:
'200':
description: アプリケーションバージョンステータスの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.readVersionStatus'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションバージョンが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/applications/{id}/packet_filter:
get:
operationId: readApplicationPacketFilter
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
summary: パケットフィルタを取得します。
description: AppRun共用型のパケットフィルタを取得します。
responses:
'200':
description: パケットフィルタの取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.readPacketFilter'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
patch:
operationId: patchApplicationPacketFilter
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
summary: パケットフィルタを部分的に変更します。
description: AppRun共用型のパケットフィルタを部分的に変更します。
requestBody:
required: true
description: 部分的に変更するパケットフィルタの情報を入力します。
content:
application/json:
schema:
$ref: '#/components/schemas/patchPacketFilterBody'
responses:
'200':
description: パケットフィルタの変更に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.patchPacketFilter'
'400':
description: リクエストが不正です。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: アプリケーションが見つかりませんでした。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/user:
get:
operationId: readUser
tags:
- セキュリティ
summary: ユーザー情報を取得します。
description: ログイン中のユーザー情報を取得します。
responses:
'200':
description: ユーザー情報の取得に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.readUser'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'404':
description: AppRun共用型にユーザーが存在しません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
post:
operationId: createUser
tags:
- セキュリティ
summary: ユーザーを作成します。
description: AppRun共用型にユーザーを作成します。
responses:
'201':
description: ユーザーの作成に成功しました。
content:
application/json:
schema:
$ref: '#/components/schemas/handler.createUser'
'401':
description: AppRun共用型の認証に失敗しました。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'403':
description: AppRun共用型に対する権限がありません。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'409':
description: AppRun共用型にユーザーがすでに存在します。
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
'500':
description: Internal server error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/model.defaultError'
- $ref: '#/components/schemas/model.cloudctrlError'
servers:
- url: https://secure.sakura.ad.jp/cloud/api/apprun/1.0/apprun/api
/alerts/projects/:
get:
operationId: listAlertProjects
description: アラートプロジェクトを管理するためのAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAlertProjectList'
description: ''
summary: アラートプロジェクト一覧取得API
post:
operationId: createAlertProject
description: アラートプロジェクトを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertProjectCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AlertProjectCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AlertProjectCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertProject'
description: ''
summary: アラートプロジェクト作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/histories/:
get:
operationId: listAlertProjectHistories
description: アラートプロジェクト内のアラート履歴を取得するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: open
schema:
type: boolean
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: query
name: severity
schema:
type: string
x-spec-enum-id: eb2a007069bad0df
enum:
- critical
- warning
description: '* `warning` - Warning
* `critical` - Critical'
- in: query
name: startsAt
schema:
type: string
format: date-time
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedHistoryList'
description: ''
summary: プロジェクトのアラート履歴一覧取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/histories/{uid}/:
get:
operationId: readAlertProjectHistory
description: アラートプロジェクト内のアラート履歴を取得するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/History'
description: ''
summary: プロジェクトのアラート履歴詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/log-measure-rules/:
get:
operationId: listAlertProjectLogMeasureRules
description: ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: log_storage_id
schema:
type: integer
format: int64
- in: query
name: metrics_storage_id
schema:
type: integer
format: int64
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLogMeasureRuleList'
description: ''
summary: ログ計測ルール一覧取得API
post:
operationId: createAlertProjectLogMeasureRule
description: ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogMeasureRuleRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogMeasureRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogMeasureRuleRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LogMeasureRule'
description: ''
summary: ログ計測ルール作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/log-measure-rules/{uid}/:
get:
operationId: readAlertProjectLogMeasureRule
description: ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogMeasureRule'
description: ''
summary: ログ計測ルール詳細取得API
put:
operationId: updateAlertProjectLogMeasureRule
description: ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogMeasureRuleRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogMeasureRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogMeasureRuleRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogMeasureRule'
description: ''
summary: ログ計測ルール更新API
patch:
operationId: patchAlertProjectLogMeasureRule
description: ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLogMeasureRuleRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLogMeasureRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLogMeasureRuleRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogMeasureRule'
description: ''
summary: ログ計測ルール部分更新API
delete:
operationId: deleteAlertProjectLogMeasureRule
description: ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: ログ計測ルール削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/notification-routings/:
get:
operationId: listAlertProjectNotificationRoutings
description: アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: query
name: target
schema:
type: integer
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedNotificationRoutingList'
description: ''
summary: 通知ルーティング一覧取得API
post:
operationId: createAlertProjectNotificationRouting
description: アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/NotificationRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/NotificationRoutingRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRouting'
description: ''
summary: 通知ルーティング作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/notification-routings/{uid}/:
get:
operationId: readAlertProjectNotificationRouting
description: アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRouting'
description: ''
summary: 通知ルーティング詳細取得API
put:
operationId: updateAlertProjectNotificationRouting
description: アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/NotificationRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/NotificationRoutingRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRouting'
description: ''
summary: 通知ルーティング更新API
patch:
operationId: patchAlertProjectNotificationRouting
description: アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedNotificationRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedNotificationRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedNotificationRoutingRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRouting'
description: ''
summary: 通知ルーティング部分更新API
delete:
operationId: deleteAlertProjectNotificationRouting
description: アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: 通知ルーティング削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/notification-routings/reorder/:
put:
operationId: reorderAlertProjectNotificationRoutings
description: アラートプロジェクト内の通知ルーティングの並び順を一括変更するAPIエンドポイントです。
summary: 通知ルーティング順序更新API
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRoutingOrderRequest'
application/x-www-form-urlencoded:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRoutingOrderRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/NotificationRoutingOrderRequest'
required: true
responses:
'204':
description: No response body
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/notification-targets/:
get:
operationId: listAlertProjectNotificationTargets
description: アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: query
name: service_type
schema:
type: string
x-spec-enum-id: 3b143ded19bdc92e
enum:
- SAKURA_EVENT_BUS
- SAKURA_SIMPLE_NOTICE
description: '* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification
* `SAKURA_EVENT_BUS` - Sakura cloud event bus'
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedNotificationTargetList'
description: ''
summary: 通知対象一覧取得API
post:
operationId: createAlertProjectNotificationTarget
description: アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTargetRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/NotificationTargetRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/NotificationTargetRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTarget'
description: ''
summary: 通知対象作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/notification-targets/{uid}/:
get:
operationId: readAlertProjectNotificationTarget
description: アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTarget'
description: ''
summary: 通知対象詳細取得API
put:
operationId: updateAlertProjectNotificationTarget
description: アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTargetRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/NotificationTargetRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/NotificationTargetRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTarget'
description: ''
summary: 通知対象更新API
patch:
operationId: patchAlertProjectNotificationTarget
description: アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedNotificationTargetRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedNotificationTargetRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedNotificationTargetRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTarget'
description: ''
summary: 通知対象部分更新API
delete:
operationId: deleteAlertProjectNotificationTarget
description: アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: 通知対象削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/rules/:
get:
operationId: listAlertProjectRules
description: アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAlertRuleList'
description: ''
summary: アラートルール一覧取得API
post:
operationId: createAlertProjectRule
description: アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AlertRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AlertRuleRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRule'
description: ''
summary: アラートルール作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/rules/{ruleUid}/histories/:
get:
operationId: listAlertProjectRuleHistories
description: ルール内のアラート履歴を取得するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: open
schema:
type: boolean
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: ruleUid
schema:
type: string
format: uuid
required: true
- in: query
name: severity
schema:
type: string
x-spec-enum-id: eb2a007069bad0df
enum:
- critical
- warning
description: '* `warning` - Warning
* `critical` - Critical'
- in: query
name: startsAt
schema:
type: string
format: date-time
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedHistoryList'
description: ''
summary: ルールのアラート履歴一覧取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/rules/{ruleUid}/histories/{uid}/:
get:
operationId: readAlertProjectRuleHistory
description: ルール内のアラート履歴を取得するAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: ruleUid
schema:
type: string
format: uuid
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/History'
description: ''
summary: ルールのアラート履歴詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{projectResourceId}/rules/{uid}/:
get:
operationId: readAlertProjectRule
description: アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRule'
description: ''
summary: アラートルール詳細取得API
put:
operationId: updateAlertProjectRule
description: アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AlertRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AlertRuleRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRule'
description: ''
summary: アラートルール更新API
patch:
operationId: patchAlertProjectRule
description: アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAlertRuleRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAlertRuleRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAlertRuleRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRule'
description: ''
summary: アラートルール部分更新API
delete:
operationId: deleteAlertProjectRule
description: アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: projectResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: アラートルール削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/alerts/projects/{resourceId}/:
get:
operationId: readAlertProject
description: アラートプロジェクトを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedAlertProject'
description: ''
summary: アラートプロジェクト詳細取得API
put:
operationId: updateAlertProject
description: アラートプロジェクトを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertProjectRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AlertProjectRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AlertProjectRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedAlertProject'
description: ''
summary: アラートプロジェクト更新API
patch:
operationId: patchAlertProject
description: アラートプロジェクトを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAlertProjectRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAlertProjectRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAlertProjectRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedAlertProject'
description: ''
summary: アラートプロジェクト部分更新API
delete:
operationId: deleteAlertProject
description: アラートプロジェクトを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: アラートプロジェクト削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/dashboards/projects/:
get:
operationId: listDashboardProjects
description: ダッシュボードを管理するためのAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDashboardProjectList'
description: ''
summary: ダッシュボード一覧取得API
post:
operationId: createDashboardProject
description: ダッシュボードを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardProjectCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DashboardProjectCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DashboardProjectCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardProject'
description: ''
summary: ダッシュボード作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/dashboards/projects/{resourceId}/:
get:
operationId: readDashboardProject
description: ダッシュボードを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedDashboardProject'
description: ''
summary: ダッシュボード詳細取得API
put:
operationId: updateDashboardProject
description: ダッシュボードを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardProjectRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DashboardProjectRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DashboardProjectRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedDashboardProject'
description: ''
summary: ダッシュボード更新API
patch:
operationId: patchDashboardProject
description: ダッシュボードを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDashboardProjectRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDashboardProjectRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDashboardProjectRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedDashboardProject'
description: ''
summary: ダッシュボード部分更新API
delete:
operationId: deleteDashboardProject
description: ダッシュボードを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: ダッシュボード削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/:
get:
operationId: listTraceStorages
description: トレースストレージを管理するためのAPIエンドポイントです。
parameters:
- in: query
name: account_id
schema:
type: string
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: log_storage__bucket__classification
schema:
type: string
x-spec-enum-id: 3896f704b7462b41
enum:
- dedicated
- shared
description: '* `shared` - 共用
* `dedicated` - 専有'
- in: query
name: resource_id
schema:
type: integer
format: int64
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTraceStorageList'
description: ''
summary: トレースストレージ一覧取得API
post:
operationId: createTraceStorage
description: トレースストレージを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorageCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TraceStorageCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TraceStorageCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorage'
description: ''
summary: トレースストレージ作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/{resourceId}/:
get:
operationId: readTraceStorage
description: トレースストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorage'
description: ''
summary: トレースストレージ詳細取得API
put:
operationId: updateTraceStorage
description: トレースストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TraceStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TraceStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorage'
description: ''
summary: トレースストレージ更新API
patch:
operationId: patchTraceStorage
description: トレースストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedTraceStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedTraceStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedTraceStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorage'
description: ''
summary: トレースストレージ部分更新API
delete:
operationId: deleteTraceStorage
description: トレースストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: トレースストレージ削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/{resourceId}/set-expire/:
post:
operationId: setTraceStorageExpire
description: トレースストレージの保存期間を設定します。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetTraceStorageExpireDayRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SetTraceStorageExpireDayRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SetTraceStorageExpireDayRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorage'
description: ''
summary: トレースストレージ有効期限設定API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/{resourceId}/stats/daily/:
get:
operationId: readTraceStorageStatsDaily
description: トレースストレージの日次利用状況を取得します。
parameters:
- in: query
name: end_date
schema:
type: string
format: date
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
- in: query
name: start_date
schema:
type: string
format: date
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorageDailyUsageBody'
description: ''
summary: トレースストレージ日次利用状況詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/{resourceId}/stats/monthly/:
get:
operationId: readTraceStorageStatsMonthly
description: トレースストレージの月次利用状況を取得します。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
- in: query
name: year
schema:
type: integer
maximum: 2100
minimum: 1970
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorageMonthlyUsageBody'
description: ''
summary: トレースストレージ月次利用状況詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/{traceResourceId}/keys/:
get:
operationId: listTraceStorageKeys
description: トレースストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: path
name: traceResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTraceStorageAccessKeyList'
description: ''
summary: トレースストレージのアクセスキー一覧取得API
post:
operationId: createTraceStorageKey
description: トレースストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: traceResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TraceStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TraceStorageAccessKeyRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorageAccessKey'
description: ''
summary: トレースストレージのアクセスキー作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/traces/storages/{traceResourceId}/keys/{uid}/:
get:
operationId: readTraceStorageKey
description: トレースストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: traceResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorageAccessKey'
description: ''
summary: トレースストレージのアクセスキー詳細取得API
put:
operationId: updateTraceStorageKey
description: トレースストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: traceResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TraceStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TraceStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TraceStorageAccessKeyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorageAccessKey'
description: ''
summary: トレースストレージのアクセスキー更新API
patch:
operationId: patchTraceStorageKey
description: トレースストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: traceResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedTraceStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedTraceStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedTraceStorageAccessKeyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedTraceStorageAccessKey'
description: ''
summary: トレースストレージのアクセスキー部分更新API
delete:
operationId: deleteTraceStorageKey
description: トレースストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: traceResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: トレースストレージのアクセスキー削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/storages/:
get:
operationId: listMetricStorages
description: メトリクスストレージを管理するためのAPIエンドポイントです。
parameters:
- in: query
name: account_id
schema:
type: string
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: is_system
schema:
type: boolean
description: Is system
- in: query
name: resource_id
schema:
type: integer
format: int64
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMetricsStorageList'
description: ''
summary: メトリクスストレージ一覧取得API
post:
operationId: createMetricStorage
description: メトリクスストレージを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorageCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricsStorageCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricsStorageCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorage'
description: ''
summary: メトリクスストレージ作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/storages/{metricsResourceId}/keys/:
get:
operationId: listMetricStorageKeys
description: メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: path
name: metricsResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMetricsStorageAccessKeyList'
description: ''
summary: メトリクスストレージのアクセスキー一覧取得API
post:
operationId: createMetricStorageKey
description: メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: metricsResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricsStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricsStorageAccessKeyRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorageAccessKey'
description: ''
summary: メトリクスストレージのアクセスキー作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/storages/{metricsResourceId}/keys/{uid}/:
get:
operationId: readMetricStorageKey
description: メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: metricsResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorageAccessKey'
description: ''
summary: メトリクスストレージのアクセスキー詳細取得API
put:
operationId: updateMetricStorageKey
description: メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: metricsResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricsStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricsStorageAccessKeyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorageAccessKey'
description: ''
summary: メトリクスストレージのアクセスキー更新API
patch:
operationId: patchMetricStorageKey
description: メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: metricsResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMetricsStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMetricsStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMetricsStorageAccessKeyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorageAccessKey'
description: ''
summary: メトリクスストレージのアクセスキー部分更新API
delete:
operationId: deleteMetricStorageKey
description: メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: metricsResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: メトリクスストレージのアクセスキー削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/storages/{resourceId}/:
get:
operationId: readMetricStorage
description: メトリクスストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorage'
description: ''
summary: メトリクスストレージ詳細取得API
put:
operationId: updateMetricStorage
description: メトリクスストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricsStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricsStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorage'
description: ''
summary: メトリクスストレージ更新API
patch:
operationId: patchMetricStorage
description: メトリクスストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMetricsStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMetricsStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMetricsStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsStorage'
description: ''
summary: メトリクスストレージ部分更新API
delete:
operationId: deleteMetricStorage
description: メトリクスストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: メトリクスストレージ削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/storages/{resourceId}/stats/daily/:
get:
operationId: readMetricStorageStatsDaily
description: メトリクスストレージの日次利用状況を取得します。
parameters:
- in: query
name: end_date
schema:
type: string
format: date
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
- in: query
name: start_date
schema:
type: string
format: date
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorageDailyUsageBody'
description: ''
summary: メトリクスストレージ日次利用状況詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/storages/{resourceId}/stats/monthly/:
get:
operationId: readMetricStorageStatsMonthly
description: メトリクスストレージの月次利用状況を取得します。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
- in: query
name: year
schema:
type: integer
maximum: 2100
minimum: 1970
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsStorageMonthlyUsageBody'
description: ''
summary: メトリクスストレージ月次利用状況詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/routings/:
get:
operationId: listMetricRoutings
description: メトリクスルーティングを管理するためのAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: publisher__code
schema:
type: string
- in: query
name: resource_id
schema:
type: integer
format: int64
description: Metrics storage resource id
- in: query
name: variant
schema:
type: string
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMetricsRoutingList'
description: ''
summary: メトリクスルーティング一覧取得API
post:
operationId: createMetricRouting
description: メトリクスルーティングを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricsRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricsRoutingRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsRouting'
description: ''
summary: メトリクスルーティング作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/metrics/routings/{uid}/:
get:
operationId: readMetricRouting
description: メトリクスルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsRouting'
description: ''
summary: メトリクスルーティング詳細取得API
put:
operationId: updateMetricRouting
description: メトリクスルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricsRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricsRoutingRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsRouting'
description: ''
summary: メトリクスルーティング更新API
patch:
operationId: patchMetricRouting
description: メトリクスルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMetricsRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMetricsRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMetricsRoutingRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedMetricsRouting'
description: ''
summary: メトリクスルーティング部分更新API
delete:
operationId: deleteMetricRouting
description: メトリクスルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: メトリクスルーティング削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/:
get:
operationId: listLogStorages
description: ログストレージを管理するためのAPIエンドポイントです。
parameters:
- in: query
name: account_id
schema:
type: string
- in: query
name: bucket__classification
schema:
type: string
x-spec-enum-id: 3896f704b7462b41
enum:
- dedicated
- shared
description: '* `shared` - 共用
* `dedicated` - 専有'
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: is_system
schema:
type: boolean
description: Is system
- in: query
name: resource_id
schema:
type: integer
format: int64
- in: query
name: status
schema:
type: string
x-spec-enum-id: 6499fdb0e233089a
enum:
- assigned
- deleted
- free
- init
- purged
description: '* `init` - 初期化中
* `free` - 未割り当て
* `assigned` - 割り当て済み
* `deleted` - 削除済み
* `purged` - ログデータ削除済み'
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLogStorageList'
description: ''
summary: ログストレージ一覧取得API
post:
operationId: createLogStorage
description: ログストレージを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorageCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogStorageCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogStorageCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorage'
description: ''
summary: ログストレージ作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/{logResourceId}/keys/:
get:
operationId: listLogStorageKeys
description: ログストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: path
name: logResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLogStorageAccessKeyList'
description: ''
summary: ログストレージのアクセスキー一覧取得API
post:
operationId: createLogStorageKey
description: ログストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: logResourceId
schema:
type: integer
format: int64
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogStorageAccessKeyRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorageAccessKey'
description: ''
summary: ログストレージのアクセスキー作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/{logResourceId}/keys/{uid}/:
get:
operationId: readLogStorageKey
description: ログストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: logResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorageAccessKey'
description: ''
summary: ログストレージのアクセスキー詳細取得API
put:
operationId: updateLogStorageKey
description: ログストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: logResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogStorageAccessKeyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorageAccessKey'
description: ''
summary: ログストレージのアクセスキー更新API
patch:
operationId: patchLogStorageKey
description: ログストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: logResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLogStorageAccessKeyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLogStorageAccessKeyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLogStorageAccessKeyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorageAccessKey'
description: ''
summary: ログストレージのアクセスキー部分更新API
delete:
operationId: deleteLogStorageKey
description: ログストレージのアクセスキーを管理するAPIエンドポイントです。
parameters:
- in: path
name: logResourceId
schema:
type: integer
format: int64
required: true
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: ログストレージのアクセスキー削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/{resourceId}/:
get:
operationId: readLogStorage
description: ログストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorage'
description: ''
summary: ログストレージ詳細取得API
put:
operationId: updateLogStorage
description: ログストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorage'
description: ''
summary: ログストレージ更新API
patch:
operationId: patchLogStorage
description: ログストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLogStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLogStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLogStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogStorage'
description: ''
summary: ログストレージ部分更新API
delete:
operationId: deleteLogStorage
description: ログストレージを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: ログストレージ削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/{resourceId}/set-expire/:
post:
operationId: setLogStorageExpire
description: ログストレージの保存期間を設定します。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetLogStorageExpireDayRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SetLogStorageExpireDayRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SetLogStorageExpireDayRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorage'
description: ''
summary: ログストレージ有効期限設定API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/{resourceId}/stats/daily/:
get:
operationId: readLogStorageStatsDaily
description: ログストレージの日次利用状況を取得します。
parameters:
- in: query
name: end_date
schema:
type: string
format: date
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
- in: query
name: start_date
schema:
type: string
format: date
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorageDailyUsageBody'
description: ''
summary: ログストレージ日次利用状況詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/storages/{resourceId}/stats/monthly/:
get:
operationId: readLogStorageStatsMonthly
description: ログストレージの月次利用状況を取得します。
parameters:
- in: path
name: resourceId
schema:
type: integer
maximum: 999999999999
minimum: 0
format: int64
title: Cloud resource id
example: 110000000000
required: true
- in: query
name: year
schema:
type: integer
maximum: 2100
minimum: 1970
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogStorageMonthlyUsageBody'
description: ''
summary: ログストレージ月次利用状況詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/routings/:
get:
operationId: listLogRoutings
description: ログルーティングを管理するためのAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: publisher__code
schema:
type: string
- in: query
name: resource_id
schema:
type: integer
format: int64
description: Log storage resource id
- in: query
name: variant
schema:
type: string
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLogRoutingList'
description: ''
summary: ログルーティング一覧取得API
post:
operationId: createLogRouting
description: ログルーティングを管理するためのAPIエンドポイントです。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogRoutingRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogRouting'
description: ''
summary: ログルーティング作成API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/logs/routings/{uid}/:
get:
operationId: readLogRouting
description: ログルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogRouting'
description: ''
summary: ログルーティング詳細取得API
put:
operationId: updateLogRouting
description: ログルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LogRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LogRoutingRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogRouting'
description: ''
summary: ログルーティング更新API
patch:
operationId: patchLogRouting
description: ログルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLogRoutingRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLogRoutingRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLogRoutingRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedLogRouting'
description: ''
summary: ログルーティング部分更新API
delete:
operationId: deleteLogRouting
description: ログルーティングを管理するためのAPIエンドポイントです。
parameters:
- in: path
name: uid
schema:
type: string
format: uuid
required: true
tags:
- セキュリティ
responses:
'204':
description: No response body
summary: ログルーティング削除API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/management/limits/:
get:
operationId: readResourceLimits
description: アカウントのリソース上限(ログストレージ、メトリクスストレージ、アラートプロジェクト、ダッシュボード)を取得するAPIエンドポイントです。
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourcesLimits'
description: ''
summary: リソース制限詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/management/provisioning/initialize/:
post:
operationId: initializeProvisioning
description: リソース(ログストレージ、メトリクスストレージ)のプロビジョニング(初期化)を行うAPIエンドポイントです。指定した種別のリソースが存在しない場合のみ作成を行います。既存のリソースは変更されません。
tags:
- セキュリティ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProvisioningCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProvisioningCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProvisioningCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Provisioning'
description: 新規リソースを作成した場合に返されます。
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Provisioning'
description: 既存のリソースが存在し、新規作成を行わなかった場合に返されます。
summary: プロビジョニング(初期化)API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/management/provisioning/state/:
get:
operationId: readProvisioningState
description: リソース(ログストレージ、メトリクスストレージ)のプロビジョニング状態を確認するAPIエンドポイントです。
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Provisioning'
description: ''
summary: プロビジョニング状態詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/publishers/:
get:
operationId: listPublishers
description: 連携サービス情報を取得するAPIエンドポイントです。
parameters:
- name: count
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: from
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPublisherList'
description: ''
summary: 連携サービス一覧取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/publishers/{code}/:
get:
operationId: readPublisher
description: 連携サービス情報を取得するAPIエンドポイントです。
parameters:
- in: path
name: code
schema:
type: string
required: true
tags:
- セキュリティ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WrappedPublisher'
description: ''
summary: 連携サービス詳細取得API
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/
/networking-suite/addresses:
get:
operationId: listAddresses
summary: アドレス一覧の取得
description: 割り当て済みのIPアドレスの一覧を取得します。
parameters:
- name: subnetSRN
in: query
required: true
description: 'サブネットのSRN
指定されたサブネットで割り当て済みのIPアドレスの一覧のみを取得します。'
schema:
type: string
explode: false
examples:
サブネットとインターフェースコネクションを指定してアドレス取得:
summary: サブネットとインターフェースコネクションを指定してアドレス取得
value: subnetSRN=srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
- name: interfaceConnectionSRN
in: query
required: false
description: "インターフェースコネクションのSRN\n\n指定されたインターフェースコネクションに割り当て済みのIPアドレスのみを取得します。\n\nインターフェースコネクションのSRNは以下のいずれかの方法で取得できます:\n- NIC (インターフェース) をサブネットへ接続する際 (`POST /networking-suite/interface-connections`) のレスポンスに含まれる `InterfaceConnection.SRN` を参照します\n- NICを接続しているサーバーの詳細情報 (`GET /server/{serverid}`; [詳細](https://manual.sakura.ad.jp/cloud-api/1.1/server/index.html)) のレスポンスに含まれる `Server.Interfaces[].NetworkingSuiteInterfaceConnection.ID` を用いてSRNを組み立てます\n - 例: `Server.Interfaces[].NetworkingSuiteInterfaceConnection.ID` が `4567890123` の場合、SRNは `srnv1:<ロケーション識別子>:sakura.networking-suite.interface-connection:4567890123` となります"
schema:
type: string
explode: false
examples:
サブネットとインターフェースコネクションを指定してアドレス取得:
summary: サブネットとインターフェースコネクションを指定してアドレス取得
value: interfaceConnectionSRN=srnv1:sakura-is1c:sakura.networking-suite.interface-connection:4567890123
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/AddressListResponse'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/addresses/{addressid}:
get:
operationId: readAddress
summary: アドレス詳細の取得
description: 割り当て済みのIPアドレスの詳細情報を取得します。
parameters:
- name: addressid
in: path
required: true
description: 'アドレスのID
アドレスのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1c:sakura.networking-suite.address:5678901234` の場合は `5678901234` を指定します。'
schema:
type: string
example: '5678901234'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/AddressResponse'
example:
Address:
SRN: srnv1:sakura-is1c:sakura.networking-suite.address:5678901234
AddressType: EPHEMERAL_ADDRESS
IPVersion: IPv4
IPAddress: 10.0.0.10
Subnet:
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/interface-connections:
post:
operationId: createInterfaceConnection
summary: NIC (インターフェース) をサブネットに接続
description: 'NIC (インターフェース) をサブネットに接続するために、インターフェースコネクションを作成します。
ネットワークスイートでは、NICとサブネットの接続関係をインターフェースコネクションというリソースで管理します。
また、NICをサブネットに接続する際に、エフェメラルIPアドレスを確保のうえ、インターフェースコネクションと紐付けて管理します。エフェメラルIPアドレスはサブネット内で一時的に割り当てられるIPアドレスであり、NICがサブネットから切断されると自動的に解放されます。
NICのSRNは、以下の手順で取得できます。
1. NICを接続しているサーバーの詳細情報 (`GET /server/{serverid}`; 詳細) のレスポンスに含まれる `Server.Interfaces[].ID` を取得します
2. 取得した `Server.Interfaces[].ID` を用いて、NICのSRNを組み立てます
- 例: `Server.Interfaces[].ID` が `3456789012` の場合、SRNは `srnv1::sakura.iaas.interface:3456789012` となります
接続するNICとサブネットは同一ゾーンに存在する必要があります。異なるゾーンのNICとサブネットを接続することはできません。'
parameters: []
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedInterfaceConnectionResponse'
examples:
NICをサブネットに接続 (IPアドレス自動割当):
summary: NICをサブネットに接続 (IPアドレス自動割当)
description: NICをサブネットに接続する際、`EphemeralIPv4Address` フィールドを省略することで、空いている未使用のエフェメラルIPアドレスを自動的に割り当てます。
value:
InterfaceConnection:
SRN: srnv1:sakura-is1c:sakura.networking-suite.interface-connection:4567890123
EphemeralIPv4Address: 10.0.0.10
NICをサブネットに接続 (IPアドレス手動指定):
summary: NICをサブネットに接続 (IPアドレス手動指定)
description: 'NICをサブネットに接続する際、`EphemeralIPv4Address` フィールドに空いている未使用のエフェメラルIPアドレスを指定することで、手動で割り当てることができます。
[マニュアル](https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html)内「仕様」に記載の条件を満たすIPアドレスを指定する必要があります。IPアドレスはサブネットのIPアドレス範囲に含まれ、かつ、同一サブネット内で他のNICに割り当て済みのIPアドレスやシステムが予約済みのIPアドレスと重複しない必要があります。'
value:
InterfaceConnection:
SRN: srnv1:sakura-is1c:sakura.networking-suite.interface-connection:4567890123
EphemeralIPv4Address: 10.0.0.10
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInterfaceConnection'
examples:
NICをサブネットに接続 (IPアドレス自動割当):
summary: NICをサブネットに接続 (IPアドレス自動割当)
description: NICをサブネットに接続する際、`EphemeralIPv4Address` フィールドを省略することで、空いている未使用のエフェメラルIPアドレスを自動的に割り当てます。
value:
Interface:
SRN: srnv1:sakura-is1c:sakura.iaas.interface:3456789012
Subnet:
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
NICをサブネットに接続 (IPアドレス手動指定):
summary: NICをサブネットに接続 (IPアドレス手動指定)
description: 'NICをサブネットに接続する際、`EphemeralIPv4Address` フィールドに空いている未使用のエフェメラルIPアドレスを指定することで、手動で割り当てることができます。
[マニュアル](https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html)内「仕様」に記載の条件を満たすIPアドレスを指定する必要があります。IPアドレスはサブネットのIPアドレス範囲に含まれ、かつ、同一サブネット内で他のNICに割り当て済みのIPアドレスやシステムが予約済みのIPアドレスと重複しない必要があります。'
value:
Interface:
SRN: srnv1:sakura-is1c:sakura.iaas.interface:3456789012
Subnet:
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
EphemeralIPv4Address: 10.0.0.10
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/interface-connections/{interfaceconnectionid}:
delete:
operationId: deleteInterfaceConnection
summary: NIC (インターフェース) をサブネットから切断
description: 'インターフェースコネクションを削除することで、NIC (インターフェース) をサブネットから切断します。
NICをサブネットから切断すると、NICに割り当てられていたエフェメラルIPアドレスは自動的に解放されます。
インターフェースコネクションを削除してNICをサブネットから切断するには、NICが接続されたサーバーが停止している必要があります。サーバーが起動中の場合、インターフェースコネクションを削除することはできません。'
parameters:
- name: interfaceconnectionid
in: path
required: true
description: "インターフェースコネクションのID\n\nインターフェースコネクションのSRNの末尾、ID部分の値を指定します。\n\nインターフェースコネクションのIDは、以下のいずれかの方法で取得できます:\n- NIC (インターフェース) をサブネットへ接続する際 (`POST /networking-suite/interface-connections`) のレスポンスに含まれる `InterfaceConnection.SRN` を参照します\n - 例: `InterfaceConnection.SRN` が `srnv1:sakura-is1c:sakura.networking-suite.interface-connection:4567890123` の場合、IDは `4567890123` となります\n- NICを接続しているサーバーの詳細情報 (`GET /server/{serverid}`; [詳細](https://manual.sakura.ad.jp/cloud-api/1.1/server/index.html)) のレスポンスに含まれる `Server.Interfaces[].NetworkingSuiteInterfaceConnection.ID` を参照します"
schema:
type: string
examples:
インターフェースコネクションを削除してNICをサブネットから切断:
summary: インターフェースコネクションを削除してNICをサブネットから切断
value: '4567890123'
responses:
'204':
description: 成功時のレスポンス (内容なし)
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/subnet-groups:
post:
operationId: createSubnetGroup
summary: サブネットグループの作成
description: サブネットグループを作成します。
parameters: []
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedSubnetGroupResponse'
examples:
サブネットグループ作成:
summary: サブネットグループ作成
value:
SubnetGroup:
Name: サブネットグループ名
Description: サブネットグループの説明
IPv4AddressRangeCIDR: 10.0.0.0/20
Region:
Code: is1
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubnetGroup'
examples:
サブネットグループ作成:
summary: サブネットグループ作成
value:
Name: サブネットグループ名
Description: サブネットグループの説明
IPv4AddressRangeCIDR: 10.0.0.0/20
Region:
Code: is1
get:
operationId: listSubnetGroups
summary: サブネットグループ一覧の取得
description: サブネットグループの一覧を取得します。
parameters: []
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetGroupListResponse'
examples:
サブネットグループ一覧の取得:
summary: サブネットグループ一覧の取得
value:
Count: 1
From: 0
SubnetGroups:
- Name: サブネットグループ名
Description: サブネットグループの説明
IPv4AddressRangeCIDR: 10.0.0.0/20
Region:
Code: is1
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
Total: 1
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/subnet-groups/{subnetgroupid}:
get:
operationId: readSubnetGroup
summary: サブネットグループ詳細の取得
description: サブネットグループの詳細を取得します。
parameters:
- name: subnetgroupid
in: path
required: true
description: 'サブネットグループのID
サブネットグループのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890` の場合は `1234567890` を指定します。'
schema:
type: string
examples:
サブネットグループ詳細の取得:
summary: サブネットグループ詳細の取得
value: '1234567890'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetGroupResponse'
examples:
サブネットグループ詳細の取得:
summary: サブネットグループ詳細の取得
value:
SubnetGroup:
Name: サブネットグループ名
Description: サブネットグループの説明
IPv4AddressRangeCIDR: 10.0.0.0/20
Region:
Code: is1
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
put:
operationId: updateSubnetGroup
summary: サブネットグループ詳細の更新
description: 'サブネットグループの詳細を更新します。
名前 (`Name`) と説明 (`Description`) のみ更新可能です。'
parameters:
- name: subnetgroupid
in: path
required: true
description: 'サブネットグループのID
サブネットグループのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890` の場合は `1234567890` を指定します。'
schema:
type: string
examples:
サブネットグループ更新:
summary: サブネットグループ更新
value: '1234567890'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetGroupResponse'
examples:
サブネットグループ更新:
summary: サブネットグループ更新
value:
SubnetGroup:
Name: 新しいサブネットグループ名
Description: 新しいサブネットグループの説明
IPv4AddressRangeCIDR: 10.0.0.0/20
Region:
Code: is1
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubnetGroup'
examples:
サブネットグループ更新:
summary: サブネットグループ更新
value:
Name: 新しいサブネットグループ名
Description: 新しいサブネットグループの説明
delete:
operationId: deleteSubnetGroup
summary: サブネットグループの削除
description: 'サブネットグループを削除します。
サブネットグループを削除するには、サブネットグループに属するサブネットがすべて削除されている必要があります。'
parameters:
- name: subnetgroupid
in: path
required: true
description: 'サブネットグループのID
サブネットグループのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890` の場合は `1234567890` を指定します。'
schema:
type: string
examples:
サブネットグループの削除:
summary: サブネットグループの削除
value: '1234567890'
responses:
'204':
description: 成功時のレスポンス (内容なし)
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/subnets:
post:
operationId: createSubnet
summary: サブネットの作成
description: サブネットグループにサブネットを作成します。
parameters: []
responses:
'201':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedSubnetResponse'
examples:
サブネット作成:
summary: サブネット作成
value:
Subnet:
Name: サブネット名
Description: サブネットの説明
IPv4AddressRangeCIDR: 10.0.0.0/26
Zone:
Code: is1c
SubnetGroup:
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubnet'
examples:
サブネット作成:
summary: サブネット作成
value:
Name: サブネット名
Description: サブネットの説明
IPv4AddressRangeCIDR: 10.0.0.0/26
Zone:
Code: is1c
SubnetGroup:
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
get:
operationId: listSubnets
summary: サブネット一覧の取得
description: サブネットの一覧を取得します。
parameters:
- name: subnetGroupSRN
in: query
required: true
description: 'サブネットグループのSRN
指定されたサブネットグループに属するサブネットの一覧のみを取得します。'
schema:
type: string
explode: false
examples:
指定したサブネットグループに属するサブネットの一覧を取得:
summary: 指定したサブネットグループに属するサブネットの一覧を取得
value: subnetGroupSRN=srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetListResponse'
examples:
指定したサブネットグループに属するサブネットの一覧を取得:
summary: 指定したサブネットグループに属するサブネットの一覧を取得
value:
Count: 1
From: 0
Subnets:
- Name: サブネット名
Description: サブネットの説明
IPv4AddressRangeCIDR: 10.0.0.0/26
Zone:
Code: is1c
SubnetGroup:
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
Total: 1
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/networking-suite/subnets/{subnetid}:
get:
operationId: readSubnet
summary: サブネット詳細の取得
description: サブネットの詳細を取得します。
parameters:
- name: subnetid
in: path
required: true
description: 'サブネットのID
サブネットのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901` の場合は `2345678901` を指定します。'
schema:
type: string
examples:
サブネット詳細を取得:
summary: サブネット詳細を取得
value: '2345678901'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetResponse'
examples:
サブネット詳細を取得:
summary: サブネット詳細を取得
value:
Subnet:
Name: サブネット名
Description: サブネットの説明
IPv4AddressRangeCIDR: 10.0.0.0/26
Zone:
Code: is1c
SubnetGroup:
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
put:
operationId: updateSubnet
summary: サブネット詳細の更新
description: 'サブネットの詳細を更新します。
名前 (`Name`) と説明 (`Description`) のみ更新可能です。'
parameters:
- name: subnetid
in: path
required: true
description: 'サブネットのID
サブネットのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901` の場合は `2345678901` を指定します。'
schema:
type: string
examples:
サブネット詳細の更新:
summary: サブネット詳細の更新
value: '2345678901'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SubnetResponse'
examples:
サブネット詳細の更新:
summary: サブネット詳細の更新
value:
Subnet:
Name: 新しいサブネット名
Description: 新しいサブネットの説明
IPv4AddressRangeCIDR: 10.0.0.0/26
Zone:
Code: is1c
SubnetGroup:
SRN: srnv1:sakura-is1:sakura.networking-suite.subnet-group:1234567890
SRN: srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubnet'
examples:
サブネット詳細の更新:
summary: サブネット詳細の更新
value:
Name: 新しいサブネット名
Description: 新しいサブネットの説明
delete:
operationId: deleteSubnet
summary: サブネットの削除
description: 'サブネットを削除します。
サブネットを削除するには、サブネットに接続されているNICがすべて切断されている必要があります。インターフェースコネクションを削除することで、NICをサブネットから切断します。'
parameters:
- name: subnetid
in: path
required: true
description: 'サブネットのID
サブネットのSRNの末尾、ID部分の値を指定します。
例: `srnv1:sakura-is1c:sakura.networking-suite.subnet:2345678901` の場合は `2345678901` を指定します。'
schema:
type: string
examples:
サブネット削除:
summary: サブネット削除
value: '2345678901'
responses:
'204':
description: 成功時のレスポンス (内容なし)
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド 石狩第3ゾーン APIエンドポイント
variables: {}
/appliance/{applianceID}/nosql/backup:
get:
tags:
- セキュリティ
summary: NoSQLバックアップ取得API
description: '対象NoSQLのバックアップ情報を取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。'
operationId: listNosqlDatabaseBackups
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlBackupResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_2'
'401':
$ref: '#/components/responses/UnauthorizedResponse_2'
'500':
$ref: '#/components/responses/ServerErrorResponse_2'
post:
tags:
- セキュリティ
summary: NoSQLバックアップ作成API
description: '対象のNoSQLに対してバックアップ作成を行います。
追加ノードのアプライアンスIDを指定してバックアップを作成することはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもバックアップが作成されます。'
operationId: createNosqlDatabaseBackup
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlOkResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_2'
'401':
$ref: '#/components/responses/UnauthorizedResponse_2'
'404':
$ref: '#/components/responses/NotFoundResponse_2'
'409':
$ref: '#/components/responses/ConflictResponse_2'
'500':
$ref: '#/components/responses/ServerErrorResponse_2'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/nosql/backup/{backupID}:
put:
tags:
- セキュリティ
summary: NoSQLバックアップ復元API
description: '対象のNoSQLに対してバックアップ復元を開始します。
バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。
追加ノードのアプライアンスIDを指定してバックアップを復元することはできません。
プライマリノードのアプライアンスIDとバックアップIDを指定することで、追加ノードに対してもバックアップの復元が適用されます。'
operationId: restoreNosqlDatabaseBackup
parameters:
- $ref: '#/components/parameters/ApplianceID'
- $ref: '#/components/parameters/BackupID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlOkResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_2'
'401':
$ref: '#/components/responses/UnauthorizedResponse_2'
'404':
$ref: '#/components/responses/NotFoundResponse_2'
'409':
$ref: '#/components/responses/ConflictResponse_2'
'500':
$ref: '#/components/responses/ServerErrorResponse_2'
delete:
tags:
- セキュリティ
summary: NoSQLバックアップ削除API
description: '対象のNoSQLのバックアップ削除を開始します。
バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。
追加ノードのアプライアンスIDを指定してバックアップを削除することはできません。
プライマリノードのアプライアンスIDとバックアップIDを指定することで、追加ノードに対してもバックアップの削除が適用されます。'
operationId: deleteNosqlDatabaseBackup
parameters:
- $ref: '#/components/parameters/ApplianceID'
- $ref: '#/components/parameters/BackupID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlOkResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_2'
'401':
$ref: '#/components/responses/UnauthorizedResponse_2'
'404':
$ref: '#/components/responses/NotFoundResponse_2'
'409':
$ref: '#/components/responses/ConflictResponse_2'
'500':
$ref: '#/components/responses/ServerErrorResponse_2'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/nosql/version:
get:
tags:
- セキュリティ
summary: NoSQLバージョン取得API
description: '対象のNoSQLの更新可能なバージョンを取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。'
operationId: listNosqlDatabaseVersions
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlVersionsResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_3'
'401':
$ref: '#/components/responses/UnauthorizedResponse_3'
'500':
$ref: '#/components/responses/ServerErrorResponse_3'
put:
tags:
- セキュリティ
summary: NoSQLバージョン更新API
description: '対象のNoSQLに対してのバージョン更新を行います。
追加ノードのアプライアンスIDを指定してバージョン更新を行うことはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもバージョン更新を行うことができます。'
operationId: updateNosqlDatabaseVersion
parameters:
- $ref: '#/components/parameters/ApplianceID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlUpdateVersionRequest'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlUpdateVersionResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_3'
'401':
$ref: '#/components/responses/UnauthorizedResponse_3'
'409':
$ref: '#/components/responses/ConflictResponse_3'
'500':
$ref: '#/components/responses/ServerErrorResponse_3'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/nosql/parameter:
get:
tags:
- セキュリティ
summary: NoSQLパラメータ取得API
description: '対象のNoSQLのパラメータ設定情報を取得します。
追加ノードのアプライアンスIDを指定して呼び出した場合、返却される情報はプライマリノードを指定した場合と同一の内容となります。'
operationId: listNosqlDatabaseParameters
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlParametersResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_4'
'401':
$ref: '#/components/responses/UnauthorizedResponse_4'
'500':
$ref: '#/components/responses/ServerErrorResponse_4'
put:
tags:
- セキュリティ
summary: NoSQLパラメータ反映API
description: '対象のNoSQLに対してのパラメータ設定を行います。
追加ノードのアプライアンスIDを指定してパラメータ設定を行うことはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもパラメータ設定を行うことができます。'
operationId: updateNosqlDatabaseParameters
parameters:
- $ref: '#/components/parameters/ApplianceID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNosqlParametersRequest'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateNosqlParametersResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_4'
'401':
$ref: '#/components/responses/UnauthorizedResponse_4'
'409':
$ref: '#/components/responses/ConflictResponse_4'
'500':
$ref: '#/components/responses/ServerErrorResponse_4'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/nosql/repair:
post:
tags:
- セキュリティ
summary: NoSQLリペア実行API
description: 'プライマリノードを対象にNoSQLのリペアを開始します。
「増分リペア」または「完全リペア」を実行します。
リペアとはデータの整合性(一貫性)を維持するために、複数のノード間で発生したデータのずれを検出・修復するメンテナンス作業です。
増分リペアは、前回のリペア実行以降に更新されたデータのみを対象に修復を行います。
完全リペアは、クラスタ内のすべてのデータを対象に修復を行います。
追加ノードのアプライアンスIDを指定してリペアを実行することはできません。
プライマリノードのアプライアンスIDを指定することで、追加ノードに対してもリペアが実行されます。'
operationId: repairNosqlDatabase
parameters:
- $ref: '#/components/parameters/ApplianceID'
requestBody:
description: リペアAPIのリクエストボディ
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlRepairRequest'
required: true
responses:
'200':
description: リペア成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlRepairResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_5'
'401':
$ref: '#/components/responses/UnauthorizedResponse_5'
'404':
$ref: '#/components/responses/NotFoundResponse_3'
'409':
$ref: '#/components/responses/ConflictResponse_5'
'500':
$ref: '#/components/responses/ServerErrorResponse_5'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/power:
put:
tags:
- セキュリティ
summary: NoSQL起動API
description: '対象のNoSQLを起動します。
プライマリノードのアプライアンスIDを指定しての起動では、ノード追加したデータは起動しません。
ノード追加している場合は、追加ノードのアプライアンスIDを指定して、個別に起動する必要があります。'
operationId: powerOnNosqlDatabase
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: NoSQL起動成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_6'
'401':
$ref: '#/components/responses/UnauthorizedResponse_6'
'404':
$ref: '#/components/responses/NotFoundResponse_4'
'409':
$ref: '#/components/responses/ConflictResponse_6'
'500':
$ref: '#/components/responses/ServerErrorResponse_6'
delete:
tags:
- セキュリティ
summary: NoSQL停止API
description: '対象のNoSQLを停止します。
プライマリノードのアプライアンスIDを指定しての停止では、ノード追加したデータは停止しません。
ノード追加している場合は、追加ノードのアプライアンスIDを指定して、個別に停止する必要があります。'
operationId: powerOffNosqlDatabase
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'202':
description: NoSQL停止成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_6'
'401':
$ref: '#/components/responses/UnauthorizedResponse_6'
'404':
$ref: '#/components/responses/NotFoundResponse_4'
'409':
$ref: '#/components/responses/ConflictResponse_6'
'500':
$ref: '#/components/responses/ServerErrorResponse_6'
get:
tags:
- セキュリティ
summary: NoSQLの電源状態取得API
description: 対象のNoSQLの電源状態を取得します。
operationId: getNosqlDatabasePower
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NosqlPower'
'400':
$ref: '#/components/responses/BadRequestResponse_6'
'401':
$ref: '#/components/responses/UnauthorizedResponse_6'
'404':
$ref: '#/components/responses/NotFoundResponse_4'
'500':
$ref: '#/components/responses/ServerErrorResponse_6'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/nosql/nodes/health:
get:
tags:
- セキュリティ
summary: NoSQLの起動状態確認API
description: 対象のNoSQL全体の起動状態を確認します。
operationId: readNosqlDatabaseNodeHealth
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/NodeHealth'
'400':
$ref: '#/components/responses/BadRequestResponse_6'
'401':
$ref: '#/components/responses/UnauthorizedResponse_6'
'404':
$ref: '#/components/responses/NotFoundResponse_4'
'500':
$ref: '#/components/responses/ServerErrorResponse_6'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/appliance/{applianceID}/nosql/nodes/recover:
post:
tags:
- セキュリティ
summary: NoSQL状態復旧API
description: '対象のNoSQLのノードを復旧します。
起動状態を確認し、停止している場合は、再起動を試みます。'
operationId: recoverNosqlDatabaseNode
parameters:
- $ref: '#/components/parameters/ApplianceID'
responses:
'200':
description: 全ノードが起動している状態。復旧不要のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'202':
description: 一台停止している状態。復旧開始のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
$ref: '#/components/responses/BadRequestResponse_6'
'401':
$ref: '#/components/responses/UnauthorizedResponse_6'
'404':
$ref: '#/components/responses/NotFoundResponse_4'
'409':
description: 二台以上停止している状態。復旧不可のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
'500':
$ref: '#/components/responses/ServerErrorResponse_6'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
/clusters:
get:
operationId: listClusters
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1
summary: サイト一覧の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
responses:
'200':
description: サイト一覧の取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ListClustersResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/clusters/{id}:
get:
operationId: readCluster
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1
summary: サイトの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- description: サイトID
name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: サイトの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ReadClusterResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: サイトが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/account:
get:
operationId: readAccount
tags:
- セキュリティ
summary: サイトアカウントの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'200':
description: サイトアカウントの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: サイトアカウントが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
post:
operationId: createAccount
tags:
- セキュリティ
summary: サイトアカウントの作成
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'201':
description: サイトアカウントの作成に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'403':
description: 新規のサイトアカウント作成が拒否されました
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
'409':
description: サイトアカウントはすでに作成済みです
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
delete:
operationId: deleteAccount
tags:
- セキュリティ
summary: サイトアカウントの削除
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'204':
description: サイトアカウントの削除に成功しました
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'409':
description: サイトアカウントに関係するリソースが残っています、先にそれらのリソースを削除する必要があります
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/account/keys:
get:
operationId: listAccountKeys
tags:
- セキュリティ
summary: サイトアカウントのアクセスキーの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'200':
description: サイトアカウントのアクセスキーの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/accountKeys'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: サイトアカウントが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
post:
operationId: createAccountKey
tags:
- セキュリティ
summary: サイトアカウントのアクセスキーの発行
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'201':
description: サイトアカウントのアクセスキーの発行に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/accountKey'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: サイトアカウントが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
'409':
description: サイトアカウントのアクセスキーが上限に達しています
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/account/keys/{id}:
get:
operationId: readAccountKey
tags:
- セキュリティ
summary: サイトアカウントのアクセスキーの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: string
required: true
description: アクセスキーID
responses:
'200':
description: サイトアカウントのアクセスキーの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/readAccountKey'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: アクセスキーが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
delete:
operationId: deleteAccountKey
tags:
- セキュリティ
summary: サイトアカウントのアクセスキーの削除
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: string
required: true
description: アクセスキーID
responses:
'204':
description: サイトアカウントのアクセスキーの削除に成功しました
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/status:
get:
operationId: readStatus
tags:
- セキュリティ
summary: サイトのステータスの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'200':
description: サイトのステータスの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets:
get:
operationId: listBuckets
tags:
- セキュリティ
summary: バケット一覧の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'200':
description: バケット一覧の取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ListBucketsResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}:
put:
operationId: createBucket
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1
summary: バケットの作成
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/handler.CreateBucketRequestBody'
description: 作成したいバケット情報
required: true
responses:
'201':
description: バケット作成に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.CreateBucketResponse'
'400':
description: バケット名が不正です
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'404':
description: サイトアカウントが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
'409':
description: 同名バケットがすでに存在する、または制限値の上限に達したためバケット作成ができません
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
security:
- BasicAuth: []
delete:
operationId: deleteBucket
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1
summary: バケットの削除
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
responses:
'204':
description: バケット削除に成功しました
'400':
description: バケット名が不正です
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'409':
description: バケットに関係するリソースが残っています、先にそれらのリソースを削除する必要があります
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/replication:
get:
operationId: readBucketReplication
tags:
- セキュリティ
summary: バケットのレプリケーション設定の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
responses:
'200':
description: レプリケーション設定の取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ReadBucketReplicationResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
post:
operationId: createBucketReplication
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1
summary: バケットのレプリケーション設定の作成
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- dest_bucket
properties:
dest_bucket:
type: string
responses:
'201':
description: レプリケーション設定の作成に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.CreateBucketReplicationResponse'
'400':
description: 不正なリクエストです
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
delete:
operationId: deleteBucketReplication
tags:
- セキュリティ
summary: レプリケーション設定の削除
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
responses:
'204':
description: レプリケーション設定の削除に成功しました
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/replicable-targets:
get:
operationId: listBucketReplicableTargets
tags:
- セキュリティ
summary: バケットのレプリケーション設定可能なディスティネーションバケットを取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/clusters` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/fed/v1/clusters`
となります。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
responses:
'200':
description: レプリケーション設定可能なディスティネーションバケットの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ListBucketReplicableTargetsResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/encryption:
get:
operationId: readBucketEncryption
tags:
- セキュリティ
summary: バケット暗号化設定の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
responses:
'200':
description: バケット暗号化設定の取得に成功しました
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/handler.ReadBucketEncryptionResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
put:
operationId: updateBucketEncryption
tags:
- セキュリティ
summary: バケット暗号化設定の作成(KMSキー指定)
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/handler.UpdateBucketEncryptionRequestBody'
responses:
'200':
description: 暗号化設定の作成に成功しました
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/handler.UpdateBucketEncryptionResponse'
'400':
description: 不正なリクエストです
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
delete:
operationId: deleteBucketEncryption
tags:
- セキュリティ
summary: バケット暗号化設定の削除(無効化)
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
schema:
type: string
description: バケット名
responses:
'204':
description: バケット暗号化設定の削除に成功しました
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/plan:
get:
operationId: readBucketPlan
tags:
- セキュリティ
summary: 現在のプランを取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
description: バケット名
schema:
$ref: '#/components/schemas/BucketName'
responses:
'200':
description: 現在のプランを取得しました
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/PlanWithContract'
'400':
description: バケット名が不正です
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
'405':
description: サイトのplan typeがarchiveではありません
content:
application/json:
schema:
$ref: '#/components/schemas/Error405'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
put:
operationId: updateBucketPlan
tags:
- セキュリティ
summary: プラン変更を実行
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
description: バケット名
schema:
$ref: '#/components/schemas/BucketName'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PlanChangeReqBody'
responses:
'200':
description: プラン変更が完了しました
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/PlanChangeResBody'
'400':
description: 不正なリクエストです
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'405':
description: サイトのplan typeがarchiveではありません
content:
application/json:
schema:
$ref: '#/components/schemas/Error405'
'409':
description: コンフリクト(同時再契約、無効な状態遷移など)
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/penalty:
get:
operationId: readBucketPenalty
tags:
- セキュリティ
summary: バケットのペナルティ状況を取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
description: バケット名
schema:
$ref: '#/components/schemas/BucketName'
responses:
'200':
description: バケットのペナルティ状況を取得しました
content:
application/json:
schema:
$ref: '#/components/schemas/BucketPenalty'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーが発生しました
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/usage:
get:
operationId: readBucketUsage
tags:
- セキュリティ
summary: バケットの使用量を取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
description: バケット名
schema:
$ref: '#/components/schemas/BucketName'
responses:
'200':
description: バケットの使用量を取得しました
content:
application/json:
schema:
$ref: '#/components/schemas/BucketUsage'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーが発生しました
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/buckets/{name}/quota:
get:
operationId: readBucketQuota
tags:
- セキュリティ
summary: バケットの制限値を取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: name
required: true
description: バケット名
schema:
$ref: '#/components/schemas/BucketName'
responses:
'200':
description: バケットの制限値を取得しました
content:
application/json:
schema:
$ref: '#/components/schemas/BucketQuota'
'400':
description: 不正なリクエストです
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: 指定したバケットが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーが発生しました
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/permissions:
get:
operationId: listPermissions
tags:
- セキュリティ
summary: パーミッション一覧の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'200':
description: パーミッション一覧の取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Permissions'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
post:
operationId: createPermission
tags:
- セキュリティ
summary: パーミッションの作成
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters: []
requestBody:
description: どのバケットを制御するかを定義します。
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionBucketControlsBody'
responses:
'201':
description: パーミッションの作成に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Permission'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: あなたが所有者でない、または存在しないバケットが指定されています
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
'409':
description: 制御対象のバケットの数が上限を超えています。
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/permissions/{id}:
get:
operationId: readPermission
tags:
- セキュリティ
summary: パーミッションの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
responses:
'200':
description: パーミッションの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Permission'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: パーミッションが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
put:
operationId: updatePermission
tags:
- セキュリティ
summary: パーミッションの更新
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。
**注意**: 本APIは指定したパーミッションIDの内容を全て置き換えます。
そのため、一部のバケットの権限を変更したい場合であっても、本パーミッションIDが管理する全てのバケットに関する情報も合わせて送る必要があります。
例えば、パーミッションID`1`が管理するバケットが下記の内容であるとします(パーミッションID`1`をGETした際の内容を示しています)。
```
{
"data": {
"bucket_controls": [
{
"bucket_name": "your-bucket-name-001",
"can_read": false,
"can_write": false,
"created_at": "2021-01-01T12:59:59.371074+09:00"
},
{
"bucket_name": "your-bucket-name-002",
"can_read": false,
"can_write": false,
"created_at": "2021-01-01T12:59:59.371074+09:00"
}
]
"created_at": "2021-01-01T12:59:59.371074+09:00"
"display_name": "your-permission-001",
"id": 1
},
}
```
この内、`your-bucket-name-002`の読み込み及び書き込み権限だけを許可したい場合は下記のようなリクエストボディーを送る必要があります。
```
{
"id": 1,
"display_name": "your-permission-001",
"bucket_controls": [
{
"bucket_name": "your-bucket-name-001",
"can_read": false,
"can_write": false,
},
{
"bucket_name": "your-bucket-name-002",
"can_read": true,
"can_write": true,
}
]
}
```
実際にリクエストを送る際には上記の内容を`data.json`というファイルに保存し、以下のような入力を行います。
```
# 入力サンプル
curl -u ''01234567-89ab-cdef-0123-456789abcdef:SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM'' \
-X PUT \
-d @data.json \
https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/permissions/1
```'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
requestBody:
description: どのバケットを制御するかを定義します。
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionBucketControlsBody'
responses:
'200':
description: パーミッションの更新に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Permission'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: あなたが所有者でない、または存在しないバケットが指定されています
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
'409':
description: 制御対象のバケットの数が上限を超えています。
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
delete:
operationId: deletePermission
tags:
- セキュリティ
summary: パーミッションの削除
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
responses:
'204':
description: パーミッションの削除に成功しました
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/permissions/{id}/keys:
get:
operationId: listPermissionKeys
tags:
- セキュリティ
summary: パーミッションが保有するアクセスキー一覧の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
responses:
'200':
description: パーミッションが保有するアクセスキー一覧の取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ListPermissionKeysResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: パーミッションが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
post:
operationId: createPermissionKey
tags:
- セキュリティ
summary: パーミッションのアクセスキーの発行
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
responses:
'201':
description: パーミッションのアクセスキーの発行に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.CreatePermissionKeyResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: パーミッションが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
'409':
description: 制御対象のバケットの数が上限を超えています。
content:
application/json:
schema:
$ref: '#/components/schemas/Error409'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/permissions/{id}/keys/{key_id}:
get:
operationId: readPermissionKey
tags:
- セキュリティ
summary: パーミッションが保有するアクセスキーの取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
- name: key_id
in: path
schema:
type: string
required: true
description: パーミッションが保有するアクセスキーID
responses:
'200':
description: パーミッションが保有するアクセスキーの取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ReadPermissionKeyResponse'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: パーミッションが保有するアクセスキーが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
delete:
operationId: deletePermissionKey
tags:
- セキュリティ
summary: パーミッションが保有するアクセスキーの削除
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: パーミッションID
- name: key_id
in: path
schema:
type: string
required: true
description: パーミッションが保有するアクセスキーID
responses:
'204':
description: パーミッションが保有するアクセスキーの削除に成功しました
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
'404':
description: パーミッションが保有するアクセスキーが見つかりませんでした
content:
application/json:
schema:
$ref: '#/components/schemas/Error404'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/metering/buckets/{name}:
get:
operationId: listBucketMetering
tags:
- セキュリティ
summary: バケット使用量の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。
指定したバケットの使用量を、指定した月範囲で取得します。
取得できるデータは月次集計データとなり、日次や時間毎の詳細なデータは取得できません。
また、指定した月においてバケットの使用が無かった場合でも、ゼロ埋めされたデータが返却されます。'
parameters:
- in: path
name: name
required: true
description: バケット名
schema:
$ref: '#/components/schemas/BucketName'
- in: query
name: from
schema:
type: string
format: date
example: 2022-03
description: 範囲の開始月
required: true
- in: query
name: to
schema:
type: string
format: date
example: 2022-08
description: 範囲の終了月
required: true
responses:
'200':
description: 成功(ゼロ埋めされたレコードを含む場合があります)
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/BucketBillingItem'
'400':
description: 無効な範囲または範囲が広すぎます
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/quota:
get:
operationId: readQuota
tags:
- セキュリティ
summary: 全体制限値の取得
description: 'アクセス先ベースURL: `https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/`
上記アクセス先ベースURLと右ペインのパスを組み合わせたものがアクセス先URLになります。
例えば、右ペインのパスが `/account` の場合、アクセス先URLは、
`https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/(サイト名)/v2/account`
となります。
なお、サイト名の取得方法は「利用例>接続先サイト一覧の取得」をご参考下さい。'
responses:
'200':
description: 全体制限値の取得に成功しました
content:
application/json:
schema:
$ref: '#/components/schemas/Quota'
'401':
description: 認証に失敗しました
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
default:
description: 不明なエラーです
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDefault'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/isk01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/tky01/v2
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/objectstorage/1.0/arc02/v2
/servers/:
get:
tags:
- セキュリティ
summary: サーバー一覧
parameters:
- in: query
name: power_status
description: キャッシュされた電源状態で絞りこむ
schema:
type: string
enum:
- 'on'
- 'off'
required: false
- in: query
name: internet
description: 'インターネット接続状態の絞り込み
* `common` - 共用グローバルネットワークを利用
* `void` - インターネット接続なし
* `{dedicated_subnet_id}` - 指定した専用グローバルネットワークを利用'
schema:
type: string
example: '123456789012'
required: false
- in: query
name: private_network
description: 'ローカルネットワークの接続状態の絞り込み
このパラメーターが複数ある場合は**全てのネットワークに接続済み(AND)**が対象
* `void` - ローカル接続なし
* `{private_network_id}` - 指定したローカルネットワークを利用'
style: form
explode: true
schema:
type: array
maxItems: 5
items:
type: string
example: '123456789012'
required: false
- $ref: '#/components/parameters/tag_filter'
- $ref: '#/components/parameters/free_word_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- in: query
name: ordering
required: false
description: '並び順の指定,
__-__ から始まる場合は降順指定
* `activated` - 利用開始日順
* `nickname` - 名称順
* `power_status_stored` - 電源状態更新日時順'
schema:
type: string
enum:
- activated
- -activated
- nickname
- -nickname
- power_status_stored
- -power_status_stored
default: -activated
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/paginate_meta'
servers:
type: array
items:
$ref: '#/components/schemas/server'
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getServers
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/:
get:
tags:
- セキュリティ
summary: サーバー
description: サーバーの詳しい情報を表示
parameters:
- $ref: '#/components/parameters/server_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
server:
$ref: '#/components/schemas/server'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getServersByServerId
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/raid_status/:
get:
tags:
- セキュリティ
summary: サーバーのRAID状態を取得
description: 'サーバーのRAID状態を取得
サーバー本体の電源が入っている必要があります'
parameters:
- $ref: '#/components/parameters/server_id'
- in: query
name: refresh
required: false
description: 実機の最新状態を取得
schema:
type: boolean
default: false
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
raid_status:
type: object
properties:
overall_status:
type:
- string
- 'null'
enum:
- ok
- rebuilding
- degraded
- failed
description: '総合的なRAID論理ボリューム状態
* `ok` - 全てのRAID論理ボリュームと物理デバイスが正常
* `rebuilding` - 再構築中のRAID論理ボリュームが1つ以上ある(物理デバイスは全て正常、冗長性は低下している)
* `degraded` - 異常検出した物理デバイスが1つ以上ある(論理ボリュームは利用可能、冗長性は低下している)
* `failed` - 故障したRAID論理ボリュームが1つ以上ある(2つ以上の物理デバイスに異常があるRAID5など)
* `null` - RAID論理ボリュームがない
`failed > degraded > rebuilding > ok` の順でより深刻なものが選択される'
monitored:
type: string
format: date-time
description: RAID状態を取得した時刻
logical_volumes:
type: array
description: 作成済みRAID論理ボリュームのリスト
items:
type: object
properties:
volume_id:
type: string
description: このサーバーのRAID論理ボリュームの一意な識別子
status:
type: string
enum:
- ok
- rebuilding
- degraded
- failed
description: このRAID論理ボリュームの状態
raid_level:
type: string
description: RAIDレベル
physical_device_ids:
type: array
items:
type: string
description: この論理ボリューム内の認識済みデバイスの識別子
example: '1'
physical_devices:
description: 認識済み物理ストレージデバイスのリスト
type: array
items:
type: object
properties:
device_id:
type: string
description: サーバーの物理ストレージデバイスの一意な識別子
example: '1'
slot:
type: integer
description: 接続スロット番号
status:
type: string
enum:
- ok
- failed
description: 'この物理ストレージデバイスの状態
* `ok` - 正常
* `failed` - 異常を検知'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
'503':
description: '状態取得に失敗
* キャッシュ情報から状態を取得できなかった
* 実機の状態取得に失敗した(電源OFF時を含む)'
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_503'
security:
- account_api_key: []
operationId: getServersByServerIdRaidStatus
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/os_images/:
get:
tags:
- セキュリティ
summary: インストール可能OS一覧
parameters:
- $ref: '#/components/parameters/server_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
os_images:
type: array
items:
type: object
properties:
os_image_id:
type: string
description: インストール実行時に指定するOSイメージ名
example: centos7-x86_64
name:
type: string
description: OSの名称
example: CentOS7 x86_64
require_password:
type: boolean
description: 'インストール時にパスワード指定が必要か
(パスワード指定が必要な場合 `true`)'
manual_partition:
type: boolean
description: 'パーティション手動構成が可能か
(パーティション構成の指定が可能な場合に `true`)'
superuser_name:
type: string
description: OSインストール時に作成される管理ユーザー名
example: root
public_key_authentication:
type: boolean
description: イメージがSSH公開鍵認証に対応しているかどうか
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getServersByServerIdOsImages
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/os_install/:
post:
tags:
- セキュリティ
summary: OSインストールの実行
description: 'OSインストールの実行
このエンドポイントはサーバーのロック状態が`operational`の場合のみ実行可能で
OSインストールの実行中はロック状態が`os_install`に変わります'
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/server_id'
requestBody:
description: OSインストール情報
required: true
content:
application/json:
schema:
required:
- os_image_id
properties:
password:
$ref: '#/components/schemas/password_input'
os_image_id:
type: string
description: インストールするOSイメージ名
example: centos7-x86_64
manual_partition:
type: boolean
description: 'リモートコンソールを利用し手動パーティション指定を行う
(OSが対応している場合のみ)'
ssh_public_keys:
type: array
default: []
maxItems: 20
example:
- ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICH8nlozujNPhuaMeMSyUf+wm+YmKWqN7wZk2YDaalSf
description: '専用サーバーに登録するSSH公開鍵のリスト
SSH公開鍵認証に対応したOSイメージでのみ有効なパラメータです
`allow_password_login`が偽の場合は1つ以上の要素が必要です'
items:
type: string
description: OpenSSH互換形式の公開鍵(RSA, DSA, ECDSA, Ed25519)
example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICH8nlozujNPhuaMeMSyUf+wm+YmKWqN7wZk2YDaalSf
allow_password_login:
type: boolean
default: true
description: 'パスワードでのSSHログインの許可
SSH公開鍵認証に対応したOSイメージでのみ有効なパラメータです'
responses:
'204':
description: 処理開始
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'409':
description: 別の実行中タスクがある
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_409'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: postServersByServerIdOsInstall
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/power_status/:
get:
tags:
- セキュリティ
summary: サーバーの電源情報を取得する
parameters:
- $ref: '#/components/parameters/server_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
power_status:
type: object
properties:
status:
type: string
enum:
- 'on'
- 'off'
description: 'サーバーの電源状態
* `on` - 起動
* `off` - 停止'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
'503':
description: 実機の状態取得に失敗
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_503'
security:
- account_api_key: []
operationId: getServersByServerIdPowerStatus
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/power_control/:
post:
tags:
- セキュリティ
summary: サーバーの電源操作
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/server_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- operation
properties:
operation:
type: string
enum:
- 'on'
- soft
- reset
- 'off'
description: '操作内容
* `on` - 電源ON
* `soft` - ACPIシャットダウン(OSでの電源シャットダウン)
* `reset` - ハードウェア電源リセット(電源OFF+電源ON)
* `off` - ハードウェア電源OFF'
responses:
'204':
description: 成功
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
'503':
description: 操作に失敗
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_503'
security:
- account_api_key: []
operationId: postServersByServerIdPowerControl
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/port_channels/{port_channel_id}/:
get:
tags:
- セキュリティ
summary: ポートチャネル状態取得
parameters:
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_channel_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
port_channel:
$ref: '#/components/schemas/port_channel'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバー・ポートが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'409':
description: 設定変更ロックの競合
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_409'
'429':
$ref: '#/components/responses/generic_429'
'503':
description: 操作に失敗
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_503'
security:
- account_api_key: []
operationId: getServersByServerIdPortChannelsByPortChannelId
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/port_channels/{port_channel_id}/configure_bonding/:
post:
tags:
- セキュリティ
summary: ポートチャネル ボンディング設定
description: 'ポートチャネル ボンディング設定
このエンドポイントを実行すると配下の {port_id} が新たに採番され
論理ポート情報がリセットされる'
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_channel_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- port_channel_id
- bonding_type
properties:
bonding_type:
type: string
enum:
- lacp
- static
- single
description: 'ボンディング方式指定
* `lacp` - LACP
* `static` - static link aggregation
* `single` - ボンディングなし(単体構成)'
port_nicknames:
type:
- array
- 'null'
default: null
description: "作成するポート名称の指定\n\n* `null`の場合は自動設定 \n* ボンディング構成する場合は1要素の配列\n* ボンディングなしの場合は2要素の配列"
items:
type: string
description: ポート名称
maxLength: 50
example:
- ポート名称1
- ポート名称2
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
port_channel:
type: array
items:
$ref: '#/components/schemas/port_channel'
'400':
description: 入力値検証エラー
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/problem_details_400'
- description: 'このエンドポイント固有のエラーコードに関する補足
|項目|コード|説明|
|---|---|---|
|port_nicknames|`inconsistent`|ポート名指定の数と冗長構成状態が一致しない|'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバー・ポートチャネルが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'409':
description: 設定変更ロックの競合
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_409'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: postServersByServerIdPortChannelsByPortChannelIdConfigureBonding
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/ports/{port_id}/:
get:
tags:
- セキュリティ
summary: ポート情報取得
parameters:
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
port:
$ref: '#/components/schemas/interface_port'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバー・ポートが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
'503':
description: 操作に失敗
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_503'
security:
- account_api_key: []
operationId: getServersByServerIdPortsByPortId
x-operation-id-source: derived
patch:
tags:
- セキュリティ
summary: ポート名称設定
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- nickname
properties:
nickname:
type: string
description: ポート名称
example: ポート名称1
maxLength: 50
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
port:
type: array
items:
$ref: '#/components/schemas/interface_port'
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバー・ポートが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: patchServersByServerIdPortsByPortId
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/ports/{port_id}/traffic_graph/:
get:
tags:
- セキュリティ
summary: トラフィックデータ取得
parameters:
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_id'
- in: query
name: since
required: false
description: 取得範囲始点(過去31日前まで,未指定時は7日前)
schema:
type: string
format: date-time
- in: query
name: until
required: false
description: 取得範囲終点(未指定時は現在時刻)
schema:
type: string
format: date-time
- in: query
name: step
required: false
description: データポイント間隔(秒)
schema:
type: integer
enum:
- 300
- 600
- 3600
- 21600
default: 300
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
traffic_graph:
type: object
properties:
transmit:
type: array
description: 送信方向トラフィック
items:
type: object
properties:
timestamp:
type: string
format: date-time
description: 取得時刻
value:
type: integer
description: 1つ前のデータからの平均トラフィック(bps)
receive:
type: array
description: 受信方向トラフィック
items:
type: object
properties:
timestamp:
type: string
format: date-time
description: 取得時刻
value:
type: integer
description: 1つ前のデータからの平均トラフィック(bps)
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバ・ポートが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getServersByServerIdPortsByPortIdTrafficGraph
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/ports/{port_id}/enable/:
post:
tags:
- セキュリティ
summary: ポート有効/無効設定
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- enable
properties:
enable:
type: boolean
description: 通信を有効にする場合に `true`
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
port:
$ref: '#/components/schemas/interface_port'
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'409':
description: 別の実行中タスクがある
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_409'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: postServersByServerIdPortsByPortIdEnable
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/servers/{server_id}/ports/{port_id}/assign_network/:
post:
tags:
- セキュリティ
summary: ネットワーク接続設定の変更
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/server_id'
- $ref: '#/components/parameters/port_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 'ポートの接続ネットワーク指定
`mode=access`の場合は
* 共用グローバルネットワーク
* 専用グローバルネットワーク
* ローカルネットワーク
のいずれか1つのみ接続可能で、
複数のネットワークが指定されている場合はエラーとなる'
required:
- mode
properties:
mode:
type: string
enum:
- access
- trunk
description: 'ポートモード
* `access` - アクセスポート
* `trunk` - トランクポート'
internet_type:
type:
- string
- 'null'
default: null
enum:
- null
- common_subnet
- dedicated_subnet
description: '* `null` - インターネット接続なし
* `common_subnet` - 共用グローバルネットワーク利用
* `dedicated_subnet` - 専用グローバルネットワーク利用'
example: dedicated_subnet
dedicated_subnet_id:
type:
- string
- 'null'
default: null
description: '専用グローバルネットワークのサービスコード指定
`global_network_type`が`dedicated_subnet`の場合に必須'
example: '345678901234'
private_network_ids:
type:
- array
- 'null'
default: null
description: 接続先ローカルネットワークの配列
items:
type: string
description: 接続先ローカルネットワークのサービスコード
example: '234567890123'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
port:
$ref: '#/components/schemas/interface_port'
'400':
description: 入力値検証エラー
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/problem_details_400'
- description: 'このエンドポイント固有のエラーコードに関する補足
|項目|コード|説明|
|---|---|---|
|non_field_errors|`inconsistent`|内容に矛盾がある(アクセスモード時に複数のネットワークを指定した場合など)|'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サーバーが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'409':
description: 別の実行中タスクがある
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_409'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: postServersByServerIdPortsByPortIdAssignNetwork
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/services/:
get:
tags:
- セキュリティ
summary: サービス一覧
description: サービスの一覧を取得します。
parameters:
- in: query
name: product_category
description: サービスの種類で絞りこむ
schema:
type: string
enum:
- server
- dedicated_subnet
- private_network
- firewall
- load_balancer
required: false
- $ref: '#/components/parameters/tag_filter'
- $ref: '#/components/parameters/free_word_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- in: query
name: ordering
required: false
description: '並び順指定,
__-__ から始まる場合は降順指定
* `activated` - 利用開始日順
* `nickname` - 名称順'
schema:
type: string
enum:
- activated
- -activated
- nickname
- -nickname
default: -activated
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/paginate_meta'
services:
type: array
items:
$ref: '#/components/schemas/service'
'401':
$ref: '#/components/responses/generic_401'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getServices
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/services/{service_id}/:
get:
tags:
- セキュリティ
summary: サービス 詳細
parameters:
- $ref: '#/components/parameters/service_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
service:
$ref: '#/components/schemas/service'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サービスが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getServicesByServiceId
x-operation-id-source: derived
patch:
tags:
- セキュリティ
summary: サービスの名称・説明の変更
description: サービス名称・説明の変更
parameters:
- $ref: '#/components/parameters/header_requested_with'
- $ref: '#/components/parameters/service_id'
requestBody:
description: サービス情報
required: true
content:
application/json:
schema:
properties:
nickname:
type: string
example: サーバーやネットワークの簡潔な名前
description: 名称:サーバーやネットワークなどの表示名
maxLength: 64
description:
type:
- string
- 'null'
example: 'サーバーやネットワークの利用用途などを
自由に記述'
description: メモ:サーバーやネットワークなどの説明
maxLength: 1000
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
service:
$ref: '#/components/schemas/service'
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: サービス情報が見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: patchServicesByServiceId
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/private_networks/:
get:
tags:
- セキュリティ
summary: ローカルネットワーク 一覧
parameters:
- $ref: '#/components/parameters/tag_filter'
- $ref: '#/components/parameters/free_word_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- in: query
name: ordering
required: false
description: '並び順指定,
__-__ から始まる場合は降順指定
* `activated` - 利用開始日順
* `nickname` - 名称順'
schema:
type: string
enum:
- activated
- -activated
- nickname
- -nickname
default: -activated
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/paginate_meta'
private_networks:
type: array
items:
$ref: '#/components/schemas/private_network'
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getPrivateNetworks
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/private_networks/{private_network_id}/:
get:
tags:
- セキュリティ
summary: ローカルネットワーク 詳細
parameters:
- $ref: '#/components/parameters/private_network_id'
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
private_network:
$ref: '#/components/schemas/private_network'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: ローカルネットワークが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getPrivateNetworksByPrivateNetworkId
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/dedicated_subnets/:
get:
tags:
- セキュリティ
summary: 専用グローバルネットワーク 一覧
parameters:
- $ref: '#/components/parameters/tag_filter'
- $ref: '#/components/parameters/free_word_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- in: query
name: ordering
required: false
description: '並び順指定,
__-__ から始まる場合は降順指定
* `activated` - 利用開始日順
* `nickname` - 名称順'
schema:
type: string
enum:
- activated
- -activated
- nickname
- -nickname
default: -activated
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/paginate_meta'
dedicated_subnets:
type: array
items:
$ref: '#/components/schemas/dedicated_subnet'
'400':
$ref: '#/components/responses/generic_400'
'401':
$ref: '#/components/responses/generic_401'
'429':
$ref: '#/components/responses/generic_429'
security:
- account_api_key: []
operationId: getDedicatedSubnets
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/dedicated_subnets/{dedicated_subnet_id}/:
get:
tags:
- セキュリティ
summary: 専用グローバルネットワーク
parameters:
- $ref: '#/components/parameters/dedicated_subnet_id'
- in: query
name: refresh
required: false
description: IPv6有効状態の最新状態を取得する
schema:
type: boolean
default: true
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
dedicated_subnet:
$ref: '#/components/schemas/dedicated_subnet'
'401':
$ref: '#/components/responses/generic_401'
'404':
description: 専用グローバルネットワークが見つからない
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_404'
'429':
$ref: '#/components/responses/generic_429'
'503':
description: 状態取得に失敗
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_503'
security:
- account_api_key: []
operationId: getDedicatedSubnetsByDedicatedSubnetId
x-operation-id-source: derived
servers:
- url: https://secure.sakura.ad.jp/cloud/api/dedicated-phy/1.0/
/activation:
post:
operationId: createActivation
summary: 現在のプロジェクトの有効化
description: '現在のプロジェクトでセキュリティコントロールを有効化します。
成功時は201を返し、リクエストが不正な場合は400を返します。'
parameters: []
responses:
'201':
description: The request has succeeded and a new resource has been created as a result.
content:
application/json:
schema:
$ref: '#/components/schemas/ActivationOutput'
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'409':
description: 'リクエストが現在のリソースの状態と競合した場合のエラー。
例えば、既に存在するリソースを再度作成しようとした場合などに返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Conflict'
application/json:
schema:
$ref: '#/components/schemas/Conflict'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActivationCreateInput'
security:
- BasicAuth: []
get:
operationId: readActivation
summary: 現在のプロジェクトの有効化状態の取得
description: '現在のプロジェクトの有効化状態を取得します。
成功時は200で有効化詳細を返し、プロジェクトがまだ一度も有効化されていない場合は404を返します。'
parameters: []
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ActivationOutput'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
security:
- BasicAuth: []
put:
operationId: updateActivation
summary: 現在のプロジェクトの有効化状態の更新
description: '現在のプロジェクトの有効化状態を更新します。
成功時は200で更新後の有効化詳細を返し、リクエストが不正な場合は400を返します。'
parameters: []
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ActivationOutput'
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActivationUpdateInput'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/securitycontrol/1.0/
description: さくらのクラウド セキュリティコントロール エンドポイント
variables: {}
/automated_actions:
post:
operationId: createAutomatedAction
summary: 自動アクションの作成
description: 新しい自動アクションを作成します。
parameters: []
responses:
'201':
description: The request has succeeded and a new resource has been created as a result.
content:
application/json:
schema:
$ref: '#/components/schemas/AutomatedActionOutput'
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AutomatedActionInput'
security:
- BasicAuth: []
get:
operationId: listAutomatedActions
summary: 自動アクション一覧の取得
description: '自動アクション一覧を取得します。
pageSizeの最大値は100。100を超える値は100として扱う。
pageSize未指定時は50。'
parameters:
- name: page_size
in: query
required: false
description: '返却する要素の最大数。
サービス側でこの値より少なく返す場合がある。'
schema:
type: integer
explode: false
- name: next
in: query
required: false
description: 'このページトークンより後の要素を取得する。
このフィールドと `prev` は同時に指定できない。
ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。
無効な場合は400 Bad Requestとなる。'
schema:
type: string
explode: false
- name: prev
in: query
required: false
description: 'このページトークンより前の要素を取得する。
このフィールドと `next` は同時に指定できない。
ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。
無効な場合は400 Bad Requestとなる。'
schema:
type: string
explode: false
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AutomatedActionOutput'
nextPageToken:
type: string
description: '次ページ取得用のトークン。
このフィールドが省略されている場合は次ページなし。
次のページを取得するには、この値を次のリクエストの `next` に指定する。'
prevPageToken:
type: string
description: '前ページ取得用のトークン。
このフィールドが省略されている場合は前ページなし。
前のページを取得するには、この値を次のリクエストの `prev` に指定する。'
totalSize:
type: integer
description: 'ページネーション対象リストの全アイテム数。
この値は推定値である可能性がある。'
required:
- items
- totalSize
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/securitycontrol/1.0/
description: さくらのクラウド セキュリティコントロール エンドポイント
variables: {}
/automated_actions/{actionId}:
get:
operationId: readAutomatedAction
summary: 自動アクション詳細の取得
description: 指定されたIDの自動アクション詳細を取得します。
parameters:
- name: actionId
in: path
required: true
schema:
$ref: '#/components/schemas/AutomatedActionID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/AutomatedActionOutput'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
security:
- BasicAuth: []
put:
operationId: updateAutomatedAction
summary: 自動アクションの更新
description: 指定されたIDの自動アクションを更新します。
parameters:
- name: actionId
in: path
required: true
schema:
$ref: '#/components/schemas/AutomatedActionID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/AutomatedActionOutput'
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AutomatedActionInput'
security:
- BasicAuth: []
delete:
operationId: deleteAutomatedAction
summary: 自動アクションの削除
description: 指定されたIDの自動アクションを削除します。
parameters:
- name: actionId
in: path
required: true
schema:
$ref: '#/components/schemas/AutomatedActionID'
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/securitycontrol/1.0/
description: さくらのクラウド セキュリティコントロール エンドポイント
variables: {}
/evaluation_rules:
get:
operationId: listEvaluationRules
summary: 評価ルール一覧の取得
description: 'プロジェクトの評価ルール一覧を取得します。
pageSizeの最大値は100。100を超える値は100として扱う。
pageSize未指定時は50。'
parameters:
- name: page_size
in: query
required: false
description: '返却する要素の最大数。
サービス側でこの値より少なく返す場合がある。'
schema:
type: integer
explode: false
- name: next
in: query
required: false
description: 'このページトークンより後の要素を取得する。
このフィールドと `prev` は同時に指定できない。
ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。
無効な場合は400 Bad Requestとなる。'
schema:
type: string
explode: false
- name: prev
in: query
required: false
description: 'このページトークンより前の要素を取得する。
このフィールドと `next` は同時に指定できない。
ページネーション時、他のリクエストパラメータは元のリクエストと一致している必要がある。
無効な場合は400 Bad Requestとなる。'
schema:
type: string
explode: false
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/EvaluationRule'
nextPageToken:
type: string
description: '次ページ取得用のトークン。
このフィールドが省略されている場合は次ページなし。
次のページを取得するには、この値を次のリクエストの `next` に指定する。'
prevPageToken:
type: string
description: '前ページ取得用のトークン。
このフィールドが省略されている場合は前ページなし。
前のページを取得するには、この値を次のリクエストの `prev` に指定する。'
totalSize:
type: integer
description: 'ページネーション対象リストの全アイテム数。
この値は推定値である可能性がある。'
required:
- items
- totalSize
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/securitycontrol/1.0/
description: さくらのクラウド セキュリティコントロール エンドポイント
variables: {}
/evaluation_rules/{evaluationRuleId}:
get:
operationId: readEvaluationRule
summary: 評価ルール詳細の取得
description: 指定されたIDの評価ルール詳細を取得します。
parameters:
- name: evaluationRuleId
in: path
required: true
schema:
$ref: '#/components/schemas/EvaluationRuleID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluationRule'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
security:
- BasicAuth: []
put:
operationId: updateEvaluationRule
summary: 評価ルールの更新
description: 指定されたIDの評価ルールを更新します。
parameters:
- name: evaluationRuleId
in: path
required: true
schema:
$ref: '#/components/schemas/EvaluationRuleID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluationRule'
'400':
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequest'
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Forbidden'
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFound'
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
headers:
Retry-After:
required: false
description: クライアントが再試行するまでにどれぐらい待つべきかを示す。
schema:
anyOf:
- $ref: '#/components/schemas/clientDelaySeconds'
- $ref: '#/components/schemas/clientRetryDateTime'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
default:
description: An unexpected error response.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnexpectedError'
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
tags:
- セキュリティ
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluationRuleInput'
security:
- BasicAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/securitycontrol/1.0/
description: さくらのクラウド セキュリティコントロール エンドポイント
variables: {}
/appliance/{applianceID}/interface/{interfaceID}:
get:
operationId: readServiceEndpointGatewayInterface
summary: サービスエンドポイントゲートウェイインターフェース情報取得API
description: 指定したサービスエンドポイントゲートウェイのインターフェース情報を取得します。
parameters:
- name: applianceID
in: path
required: true
schema:
type: string
- name: interfaceID
in: path
required: true
schema:
type: string
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayInterfaceResponseBody'
default:
description: デフォルトのエラーレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド(石狩第3ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1
description: さくらのクラウド(石狩第2ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウド(石狩第1ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1
description: さくらのクラウド(サンドボックスゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
description: さくらのクラウド(東京第2ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1
description: さくらのクラウド(東京第1ゾーン)APIエンドポイント
variables: {}
/appliance/{applianceID}/reset:
put:
operationId: resetServiceEndpointGateway
summary: サービスエンドポイントゲートウェイ起動状態リセットAPI
description: 指定したサービスエンドポイントゲートウェイの起動状態をリセットします。
parameters:
- name: applianceID
in: path
required: true
schema:
type: string
responses:
'200':
description: 成功時のレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/Models.Power.UpdateServiceEndpointGatewayPowerStatusResponseBody'
default:
description: デフォルトのエラーレスポンス
content:
application/json:
schema:
$ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody'
tags:
- セキュリティ
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1
description: さくらのクラウド(石狩第3ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1
description: さくらのクラウド(石狩第2ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウド(石狩第1ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1
description: さくらのクラウド(サンドボックスゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1
description: さくらのクラウド(東京第2ゾーン)APIエンドポイント
variables: {}
- url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1
description: さくらのクラウド(東京第1ゾーン)APIエンドポイント
variables: {}
/commonserviceitem/simplenotification/routing/reorder:
put:
operationId: reorderNotificationRouting
tags:
- セキュリティ
summary: 通知ルーティングの並び替え
description: '通知ルーティングの優先順位を並び替えます。
`PriorityRank`の値は他の通知ルーティングと重複しないように指定する必要があります。'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReorderNotificationRoutingRequest'
responses:
'202':
description: Accepted
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem/simplenotification/sources:
get:
operationId: listNotificationSources
tags:
- セキュリティ
summary: 通知元一覧の取得
description: 通知ルーティングに設定する通知元の情報を取得します。
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListNotificationSourcesResponse'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem:
get:
operationId: listCommonServiceItems
tags:
- セキュリティ
summary: リソースの一覧取得
description: 'リソースの一覧取得。クエリパラメータにて下記のように`Provider.Class`を指定してフィルタを設定することで通知先、通知先グループまたは通知ルーティングのリソースのみを取得できます。
- 通知先: `/commonserviceitem?{"Filter":{"Provider.Class":"saknoticedestination"}}`
- 通知先グループ: `/commonserviceitem?{"Filter":{"Provider.Class":"saknoticegroup"}}`
- 通知ルーティング: `/commonserviceitem?{"Filter":{"Provider.Class":"saknoticerouting"}}`'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListCommonServiceItemsResponse'
examples:
通知先一覧:
$ref: '#/components/examples/ListCommonServiceItemsResponseDestinations'
通知先グループ一覧:
$ref: '#/components/examples/ListCommonServiceItemsResponseGroups'
通知ルーティング一覧:
$ref: '#/components/examples/ListCommonServiceItemsResponseRoutings'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: createCommonServiceItem
tags:
- セキュリティ
summary: リソースの作成
description: リソースの作成。`Provider.Class`の値に応じて必要な`Settings`の内容が異なります。
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostCommonServiceItemRequest'
examples:
通知先:
$ref: '#/components/examples/PostCommonServiceItemRequestDestination'
通知先グループ:
$ref: '#/components/examples/PostCommonServiceItemRequestGroup'
通知ルーティング:
$ref: '#/components/examples/PostCommonServiceItemRequestRouting'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
CommonServiceItem:
$ref: '#/components/schemas/CommonServiceItem'
required:
- CommonServiceItem
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem/{id}:
get:
operationId: readCommonServiceItem
tags:
- セキュリティ
summary: リソースの取得
description: リソースの取得。取得された`CommonServiceItem`の`Provider.Class`の値に応じて`Settings`の内容は異なります。
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^[0-9]{12}$
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
CommonServiceItem:
$ref: '#/components/schemas/CommonServiceItem'
required:
- CommonServiceItem
examples:
通知先:
$ref: '#/components/examples/ReadCommonServiceItemsResponseDestination'
通知先グループ:
$ref: '#/components/examples/ReadCommonServiceItemsResponseGroup'
通知ルーティング:
$ref: '#/components/examples/ReadCommonServiceItemsResponseRouting'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
operationId: updateCommonServiceItem
tags:
- セキュリティ
summary: リソースの更新
description: リソースの更新。更新される`CommonServiceItem`の`Provider.Class`の値に応じて`Settings`の内容は異なります。
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^[0-9]{12}$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutCommonServiceItemRequest'
examples:
通知先:
$ref: '#/components/examples/PutCommonServiceItemRequestDestination'
通知先グループ:
$ref: '#/components/examples/PutCommonServiceItemRequestGroup'
通知ルーティング:
$ref: '#/components/examples/PutCommonServiceItemRequestRouting'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
CommonServiceItem:
$ref: '#/components/schemas/CommonServiceItem'
required:
- CommonServiceItem
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: deleteCommonServiceItem
tags:
- セキュリティ
summary: リソースの削除
description: リソースの削除。
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^[0-9]{12}$
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
CommonServiceItem:
$ref: '#/components/schemas/CommonServiceItem'
required:
- CommonServiceItem
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem/{id}/simplenotification/status:
get:
operationId: checkNotificationDestinationStatus
tags:
- セキュリティ
summary: 通知先ステータス情報の取得
description: 通知先が通知送信可能かどうかのステータス情報を取得します。
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^[0-9]{12}$
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CheckDestinationStatusResponse'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem/simplenotification/history:
get:
operationId: listNotificationHistories
tags:
- セキュリティ
summary: 通知履歴の一覧取得
description: '通知履歴の一覧取得。
直近30日間以内の通知送信履歴が最大100件まで取得可能です。'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListNotificationHistoriesResponse'
examples:
通知履歴一覧:
$ref: '#/components/examples/ListNotificationHistoriesResponse'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem/simplenotification/history/{request_id}:
get:
operationId: readNotificationHistory
tags:
- セキュリティ
summary: 通知履歴の取得
description: 指定した`request_id`に対応する通知履歴の取得。
parameters:
- name: request_id
in: path
required: true
schema:
type: string
pattern: ^[0-9]+$
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ReadNotificationHistoryResponse'
examples:
通知履歴:
$ref: '#/components/examples/ReadNotificationHistoryResponse'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/commonserviceitem/{id}/simplenotification/message:
post:
operationId: sendNotification
tags:
- セキュリティ
summary: メッセージの送信
description: 指定した通知先グループに対してメッセージを送信します。
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^[0-9]{12}$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SendNotificationRequest'
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/SendNotificationResponse'
default:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1
description: さくらのクラウドAPIエンドポイント
/workflows/{id}/executions:
post:
operationId: createExecution
summary: ワークフローを実行する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
requestBody:
content:
application/json:
schema:
type: object
properties:
RevisionId:
type: integer
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Args:
type: string
minLength: 1
maxLength: 65536
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
example:
RevisionId: 123
RevisionAlias: sampleString
Args: sampleString
Name: sampleString
responses:
'201':
description: ワークフローの実行開始をキューに登録した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Execution:
type: object
properties:
ExecutionId:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
Status:
type: string
enum:
- Queued
- Running
- Succeeded
- Failed
- Canceling
- Canceled
Revision:
type: integer
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Args:
type: string
minLength: 1
maxLength: 65536
StepCount:
default: 0
type: integer
minimum: 0
Result:
type: string
minLength: 1
maxLength: 65536
Error:
type: string
minLength: 1
maxLength: 65536
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
RunAt:
type: string
format: date-time
FailedAt:
type: string
format: date-time
SucceededAt:
type: string
format: date-time
CancelRequestedAt:
type: string
format: date-time
CanceledAt:
type: string
format: date-time
required:
- ExecutionId
- Name
- Workflow
- Status
- Revision
- RevisionAlias
- Args
- StepCount
- Result
- Error
- CreatedAt
- UpdatedAt
required:
- is_ok
- Execution
example:
is_ok: true
Execution:
ExecutionId: sampleString
Name: sampleString
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
Status: Queued
Revision: 123
RevisionAlias: sampleString
Args: sampleString
StepCount: 0
Result: sampleString
Error: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
RunAt: 2020-01-01 00:00:00+00:00
FailedAt: 2020-01-01 00:00:00+00:00
SucceededAt: 2020-01-01 00:00:00+00:00
CancelRequestedAt: 2020-01-01 00:00:00+00:00
CanceledAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'409':
description: ワークフローを実行できない状態
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: sampleString
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
get:
operationId: listExecutions
summary: ワークフローの実行の一覧を取得する
tags:
- セキュリティ
parameters:
- name: Page
in: query
description: ページ番号
required: false
schema:
default: 1
type: integer
minimum: 1
example: 1
- name: PageLimit
in: query
description: 1ページあたりのリソースの取得数
required: false
schema:
default: 20
type: integer
minimum: 5
maximum: 500
example: 20
- name: Order
in: query
description: ソートの順序
required: false
schema:
type: string
enum:
- asc
- desc
example: asc
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローの実行の一覧の取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Total:
default: 0
type: integer
minimum: 0
From:
default: 0
type: integer
minimum: 0
Count:
default: 0
type: integer
minimum: 0
Executions:
type: array
items:
type: object
properties:
ExecutionId:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
Status:
type: string
enum:
- Queued
- Running
- Succeeded
- Failed
- Canceling
- Canceled
Revision:
type: integer
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Args:
type: string
minLength: 1
maxLength: 65536
StepCount:
default: 0
type: integer
minimum: 0
Result:
type: string
minLength: 1
maxLength: 65536
Error:
type: string
minLength: 1
maxLength: 65536
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
RunAt:
type: string
format: date-time
FailedAt:
type: string
format: date-time
SucceededAt:
type: string
format: date-time
CancelRequestedAt:
type: string
format: date-time
CanceledAt:
type: string
format: date-time
required:
- ExecutionId
- Name
- Workflow
- Status
- Revision
- RevisionAlias
- Args
- StepCount
- Result
- Error
- CreatedAt
- UpdatedAt
required:
- is_ok
- Total
- From
- Count
- Executions
example:
is_ok: true
Total: 0
From: 0
Count: 0
Executions:
- ExecutionId: sampleString
Name: sampleString
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
Status: Queued
Revision: 123
RevisionAlias: sampleString
Args: sampleString
StepCount: 0
Result: sampleString
Error: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
RunAt: 2020-01-01 00:00:00+00:00
FailedAt: 2020-01-01 00:00:00+00:00
SucceededAt: 2020-01-01 00:00:00+00:00
CancelRequestedAt: 2020-01-01 00:00:00+00:00
CanceledAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}/executions/{executionId}/cancel:
post:
operationId: cancelExecution
summary: ワークフローの実行をキャンセルする
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: executionId
in: path
description: Execution ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローの実行キャンセルが完了した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Execution:
type: object
properties:
ExecutionId:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
Status:
type: string
enum:
- Queued
- Running
- Succeeded
- Failed
- Canceling
- Canceled
Revision:
type: integer
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Args:
type: string
minLength: 1
maxLength: 65536
StepCount:
default: 0
type: integer
minimum: 0
Result:
type: string
minLength: 1
maxLength: 65536
Error:
type: string
minLength: 1
maxLength: 65536
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
RunAt:
type: string
format: date-time
FailedAt:
type: string
format: date-time
SucceededAt:
type: string
format: date-time
CancelRequestedAt:
type: string
format: date-time
CanceledAt:
type: string
format: date-time
required:
- ExecutionId
- Name
- Workflow
- Status
- Revision
- RevisionAlias
- Args
- StepCount
- Result
- Error
- CreatedAt
- UpdatedAt
required:
- is_ok
- Execution
example:
is_ok: true
Execution:
ExecutionId: sampleString
Name: sampleString
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
Status: Queued
Revision: 123
RevisionAlias: sampleString
Args: sampleString
StepCount: 0
Result: sampleString
Error: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
RunAt: 2020-01-01 00:00:00+00:00
FailedAt: 2020-01-01 00:00:00+00:00
SucceededAt: 2020-01-01 00:00:00+00:00
CancelRequestedAt: 2020-01-01 00:00:00+00:00
CanceledAt: 2020-01-01 00:00:00+00:00
'202':
description: ワークフローの実行キャンセルをキューに登録した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Execution:
type: object
properties:
ExecutionId:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
Status:
type: string
enum:
- Queued
- Running
- Succeeded
- Failed
- Canceling
- Canceled
Revision:
type: integer
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Args:
type: string
minLength: 1
maxLength: 65536
StepCount:
default: 0
type: integer
minimum: 0
Result:
type: string
minLength: 1
maxLength: 65536
Error:
type: string
minLength: 1
maxLength: 65536
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
RunAt:
type: string
format: date-time
FailedAt:
type: string
format: date-time
SucceededAt:
type: string
format: date-time
CancelRequestedAt:
type: string
format: date-time
CanceledAt:
type: string
format: date-time
required:
- ExecutionId
- Name
- Workflow
- Status
- Revision
- RevisionAlias
- Args
- StepCount
- Result
- Error
- CreatedAt
- UpdatedAt
required:
- is_ok
- Execution
example:
is_ok: true
Execution:
ExecutionId: sampleString
Name: sampleString
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
Status: Queued
Revision: 123
RevisionAlias: sampleString
Args: sampleString
StepCount: 0
Result: sampleString
Error: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
RunAt: 2020-01-01 00:00:00+00:00
FailedAt: 2020-01-01 00:00:00+00:00
SucceededAt: 2020-01-01 00:00:00+00:00
CancelRequestedAt: 2020-01-01 00:00:00+00:00
CanceledAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'409':
description: ワークフローの実行をキャンセルできない状態
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: sampleString
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}/executions/{executionId}:
get:
operationId: readExecution
summary: ワークフローの実行を取得する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: executionId
in: path
description: Execution ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローの実行の取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Execution:
type: object
properties:
ExecutionId:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
Status:
type: string
enum:
- Queued
- Running
- Succeeded
- Failed
- Canceling
- Canceled
Revision:
type: integer
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Args:
type: string
minLength: 1
maxLength: 65536
StepCount:
default: 0
type: integer
minimum: 0
Result:
type: string
minLength: 1
maxLength: 65536
Error:
type: string
minLength: 1
maxLength: 65536
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
RunAt:
type: string
format: date-time
FailedAt:
type: string
format: date-time
SucceededAt:
type: string
format: date-time
CancelRequestedAt:
type: string
format: date-time
CanceledAt:
type: string
format: date-time
required:
- ExecutionId
- Name
- Workflow
- Status
- Revision
- RevisionAlias
- Args
- StepCount
- Result
- Error
- CreatedAt
- UpdatedAt
required:
- is_ok
- Execution
example:
is_ok: true
Execution:
ExecutionId: sampleString
Name: sampleString
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
Status: Queued
Revision: 123
RevisionAlias: sampleString
Args: sampleString
StepCount: 0
Result: sampleString
Error: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
RunAt: 2020-01-01 00:00:00+00:00
FailedAt: 2020-01-01 00:00:00+00:00
SucceededAt: 2020-01-01 00:00:00+00:00
CancelRequestedAt: 2020-01-01 00:00:00+00:00
CanceledAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
delete:
operationId: deleteExecution
summary: ワークフローの実行を削除する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: executionId
in: path
description: Execution ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローの削除に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
required:
- is_ok
example:
is_ok: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'409':
description: ワークフローの実行を削除できない状態
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: sampleString
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}/executions/{executionId}/exec_history:
get:
operationId: listExecutionHistories
summary: ワークフローの実行履歴を取得する
tags:
- セキュリティ
parameters:
- name: Page
in: query
description: ページ番号
required: false
schema:
default: 1
type: integer
minimum: 1
example: 1
- name: PageLimit
in: query
description: 1ページあたりのリソースの取得数
required: false
schema:
default: 20
type: integer
minimum: 5
maximum: 500
example: 20
- name: SortOrder
in: query
description: ソートの順序
required: false
schema:
type: string
enum:
- asc
- desc
example: asc
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: executionId
in: path
description: Execution ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローの実行履歴の取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Total:
default: 0
type: integer
minimum: 0
From:
default: 0
type: integer
minimum: 0
Count:
default: 0
type: integer
minimum: 0
Histories:
type: array
items:
type: object
properties:
WorkflowExecutionId:
type: string
minLength: 1
maxLength: 36
JobId:
type: string
minLength: 1
maxLength: 64
ThreadId:
type: string
minLength: 1
maxLength: 64
Type:
type: string
enum:
- workflowWillStart
- workflowDidSuspended
- workflowWillResume
- workflowDidCompleted
- workflowDidFailed
- workflowDidCanceled
- stepWillExecute
- stepDidExecuted
- functionWillCall
- functionWillRun
- functionDidRun
- functionDidFailed
CreatedAt:
type: string
format: date-time
Meta:
type: string
minLength: 1
StackTrace:
type: string
minLength: 1
Variables:
type: string
minLength: 1
required:
- WorkflowExecutionId
- JobId
- ThreadId
- Type
- CreatedAt
- Meta
- StackTrace
- Variables
required:
- is_ok
- Total
- From
- Count
- Histories
example:
is_ok: true
Total: 0
From: 0
Count: 0
Histories:
- WorkflowExecutionId: sampleString
JobId: sampleString
ThreadId: sampleString
Type: workflowWillStart
CreatedAt: 2020-01-01 00:00:00+00:00
Meta: sampleString
StackTrace: sampleString
Variables: sampleString
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows:
post:
operationId: createWorkflow
summary: ワークフローを作成する
tags:
- セキュリティ
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Runbook:
type: string
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Name
- Runbook
- Publish
- Logging
example:
Name: sampleString
Description: sampleString
Runbook: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
RevisionAlias: sampleString
ServicePrincipalId: sampleString
ConcurrencyMode: parallel
responses:
'201':
description: ワークフローの作成に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
required:
- is_ok
- Workflow
example:
is_ok: true
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
get:
operationId: listWorkflows
summary: ワークフローの一覧を取得する
tags:
- セキュリティ
parameters:
- name: Page
in: query
description: ページ番号
required: false
schema:
default: 1
type: integer
minimum: 1
example: 1
- name: PageLimit
in: query
description: 1ページあたりのリソースの取得数
required: false
schema:
default: 20
type: integer
minimum: 5
maximum: 500
example: 20
- name: SortBy
in: query
description: Workflowのソートに利用するプロパティ
required: false
schema:
type: string
enum:
- createdAt
- updatedAt
- id
example: createdAt
- name: Order
in: query
description: ソートの順序
required: false
schema:
type: string
enum:
- asc
- desc
example: asc
- name: Published
in: query
description: 公開状態の絞り込み
required: false
schema:
type: boolean
example: true
- name: Name
in: query
description: ワークフロー名の絞り込み
required: false
schema:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
example: sampleString
- name: NameMatchType
in: query
description: ワークフロー名の絞り込み方法
required: false
schema:
type: string
enum:
- partial
- prefix
example: partial
responses:
'200':
description: ワークフローの一覧の取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Total:
default: 0
type: integer
minimum: 0
From:
default: 0
type: integer
minimum: 0
Count:
default: 0
type: integer
minimum: 0
Workflows:
type: array
items:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
required:
- is_ok
- Total
- From
- Count
- Workflows
example:
is_ok: true
Total: 0
From: 0
Count: 0
Workflows:
- Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/suggest:
get:
operationId: listSuggestions
summary: ワークフローのサジェストを取得する
tags:
- セキュリティ
parameters:
- name: Name
in: query
description: ワークフロー名の絞り込み
required: true
schema:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
example: sampleString
- name: Page
in: query
description: ページ番号
required: false
schema:
default: 1
type: integer
minimum: 1
example: 1
- name: PageLimit
in: query
description: 1ページあたりのリソースの取得数
required: false
schema:
default: 20
type: integer
minimum: 5
maximum: 500
example: 20
- name: SortBy
in: query
description: サジェストのソートに利用するプロパティ
required: false
schema:
type: string
enum:
- name
- count
example: name
- name: Order
in: query
description: ソートの順序
required: false
schema:
type: string
enum:
- asc
- desc
example: asc
responses:
'200':
description: ワークフローのサジェストの取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Total:
default: 0
type: integer
minimum: 0
From:
default: 0
type: integer
minimum: 0
Count:
default: 0
type: integer
minimum: 0
Suggests:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Count:
type: integer
minimum: 1
required:
- Name
- Count
required:
- is_ok
- Total
- From
- Count
- Suggests
example:
is_ok: true
Total: 0
From: 0
Count: 0
Suggests:
- Name: sampleString
Count: 123
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}:
get:
operationId: readWorkflow
summary: ワークフローを取得する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローの取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
required:
- is_ok
- Workflow
example:
is_ok: true
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
patch:
operationId: patchWorkflow
summary: ワークフローを更新する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
example:
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ConcurrencyMode: parallel
responses:
'200':
description: ワークフローの更新に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Workflow:
type: object
properties:
Id:
type: string
minLength: 1
maxLength: 36
Name:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]+$
Description:
type: string
minLength: 0
maxLength: 1024
Publish:
type: boolean
Logging:
type: boolean
Tags:
type: array
items:
type: object
properties:
Name:
type: string
minLength: 1
maxLength: 64
required:
- Name
ServicePrincipalId:
oneOf:
- type: string
pattern: ^[0-9]{12}$
- type: number
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
ConcurrencyMode:
type: string
enum:
- parallel
- lock
- queue
required:
- Id
- Name
- Publish
- Logging
- Tags
- CreatedAt
- UpdatedAt
required:
- is_ok
- Workflow
example:
is_ok: true
Workflow:
Id: sampleString
Name: sampleString
Description: sampleString
Publish: true
Logging: true
Tags:
- Name: sampleString
ServicePrincipalId: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
ConcurrencyMode: parallel
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
delete:
operationId: deleteWorkflow
summary: ワークフローを削除する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローを削除に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
required:
- is_ok
example:
is_ok: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'409':
description: ワークフローを削除できない状態
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: sampleString
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}/revisions:
post:
operationId: createRevision
summary: ワークフローのリビジョンを追加する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Runbook:
type: string
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
required:
- Runbook
example:
Runbook: sampleString
RevisionAlias: sampleString
responses:
'201':
description: ワークフローのリビジョンの追加に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Revision:
type: object
properties:
RevisionId:
type: integer
WorkflowId:
type: string
minLength: 1
maxLength: 36
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Runbook:
type: string
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
required:
- RevisionId
- WorkflowId
- Runbook
- CreatedAt
- UpdatedAt
required:
- is_ok
- Revision
example:
is_ok: true
Revision:
RevisionId: 123
WorkflowId: sampleString
RevisionAlias: sampleString
Runbook: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'409':
description: Duplicate revision alias
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: sampleString
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
get:
operationId: listRevisions
summary: ワークフローのリビジョンの一覧を取得する
tags:
- セキュリティ
parameters:
- name: Page
in: query
description: ページ番号
required: false
schema:
default: 1
type: integer
minimum: 1
example: 1
- name: PageLimit
in: query
description: 1ページあたりのリソースの取得数
required: false
schema:
default: 20
type: integer
minimum: 5
maximum: 500
example: 20
- name: SortBy
in: query
description: Workflowのソートに利用するプロパティ
required: false
schema:
type: string
enum:
- createdAt
- updatedAt
- id
example: createdAt
- name: Order
in: query
description: ソートの順序
required: false
schema:
type: string
enum:
- asc
- desc
example: asc
- name: Published
in: query
description: 公開状態の絞り込み
required: false
schema:
type: boolean
example: true
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
responses:
'200':
description: ワークフローのリビジョンの一覧の取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Total:
default: 0
type: integer
minimum: 0
From:
default: 0
type: integer
minimum: 0
Count:
default: 0
type: integer
minimum: 0
Revisions:
type: array
items:
type: object
properties:
RevisionId:
type: integer
WorkflowId:
type: string
minLength: 1
maxLength: 36
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Runbook:
type: string
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
required:
- RevisionId
- WorkflowId
- Runbook
- CreatedAt
- UpdatedAt
required:
- is_ok
- Total
- From
- Count
- Revisions
example:
is_ok: true
Total: 0
From: 0
Count: 0
Revisions:
- RevisionId: 123
WorkflowId: sampleString
RevisionAlias: sampleString
Runbook: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}/revisions/{revisionId}:
get:
operationId: readRevision
summary: ワークフローのリビジョンを取得する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: revisionId
in: path
description: Revision ID
required: true
schema:
type: integer
example: 123
responses:
'200':
description: ワークフローのリビジョンの取得に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Revision:
type: object
properties:
RevisionId:
type: integer
WorkflowId:
type: string
minLength: 1
maxLength: 36
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Runbook:
type: string
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
required:
- RevisionId
- WorkflowId
- Runbook
- CreatedAt
- UpdatedAt
required:
- is_ok
- Revision
example:
is_ok: true
Revision:
RevisionId: 123
WorkflowId: sampleString
RevisionAlias: sampleString
Runbook: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
/workflows/{id}/revisions/{revisionId}/revision_alias:
put:
operationId: updateRevisionAlias
summary: ワークフローのリビジョンエイリアスを更新する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: revisionId
in: path
description: Revision ID
required: true
schema:
type: integer
example: 123
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
required:
- RevisionAlias
example:
RevisionAlias: sampleString
responses:
'200':
description: ワークフローのリビジョンエイリアスの更新に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Revision:
type: object
properties:
RevisionId:
type: integer
WorkflowId:
type: string
minLength: 1
maxLength: 36
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Runbook:
type: string
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
required:
- RevisionId
- WorkflowId
- Runbook
- CreatedAt
- UpdatedAt
required:
- is_ok
- Revision
example:
is_ok: true
Revision:
RevisionId: 123
WorkflowId: sampleString
RevisionAlias: sampleString
Runbook: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'409':
description: Duplicate revision alias
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: sampleString
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
delete:
operationId: deleteRevisionAlias
summary: ワークフローのリビジョンエイリアスを削除する
tags:
- セキュリティ
parameters:
- name: id
in: path
description: Workflow ID
required: true
schema:
type: string
minLength: 1
maxLength: 36
example: sampleString
- name: revisionId
in: path
description: Revision ID
required: true
schema:
type: integer
example: 123
responses:
'200':
description: ワークフローのリビジョンエイリアスの削除に成功した
content:
application/json:
schema:
type: object
properties:
is_ok:
type: boolean
Revision:
type: object
properties:
RevisionId:
type: integer
WorkflowId:
type: string
minLength: 1
maxLength: 36
RevisionAlias:
type: string
minLength: 0
maxLength: 64
pattern: ^[a-zA-Z0-9_\-ーぁ-んァ-ヶ一-龠]*$
Runbook:
type: string
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
required:
- RevisionId
- WorkflowId
- Runbook
- CreatedAt
- UpdatedAt
required:
- is_ok
- Revision
example:
is_ok: true
Revision:
RevisionId: 123
WorkflowId: sampleString
RevisionAlias: sampleString
Runbook: sampleString
CreatedAt: 2020-01-01 00:00:00+00:00
UpdatedAt: 2020-01-01 00:00:00+00:00
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Unauthorized
'402':
description: Payment Required
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Payment Required
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
is_ok:
default: false
type: boolean
Message:
type: string
required:
- is_ok
- Message
example:
is_ok: false
Message: Internal Server Error
security:
- ApiKeyAuth: []
servers:
- url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0
components:
schemas:
VulnerabilityResponseBody:
type: object
properties:
resourceGroupName:
type:
- string
- 'null'
description: リソースグループ名
installScript:
type:
- string
- 'null'
description: インストールスクリプト
additionalProperties: false
description: 脆弱性検出サービスリソース作成APIのレスポンス
DdosRequestBody:
required:
- endpoint
- location
- profile
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
profile:
$ref: '#/components/schemas/FrontDoorProfile'
endpoint:
$ref: '#/components/schemas/FrontDoorEndpoint'
additionalProperties: false
description: セキュリティ機能 DDoSサービスの作成APIで受信するリクエストボディを表します。
ResourceGroupResource:
type: object
properties:
id:
$ref: '#/components/schemas/ResourceIdentifier'
hasData:
type: boolean
readOnly: true
data:
$ref: '#/components/schemas/ResourceGroupData'
additionalProperties: false
SystemData:
type: object
properties:
createdBy:
type:
- string
- 'null'
readOnly: true
createdByType:
$ref: '#/components/schemas/CreatedByType'
createdOn:
type:
- string
- 'null'
format: date-time
readOnly: true
lastModifiedBy:
type:
- string
- 'null'
readOnly: true
lastModifiedByType:
$ref: '#/components/schemas/CreatedByType'
lastModifiedOn:
type:
- string
- 'null'
format: date-time
readOnly: true
additionalProperties: false
PricingLevel:
enum:
- 1
- 2
type: integer
description: 'Front Doorリソースの価格レベルを指定します。指定値と価格レベルの対応は次の通りです。
- 1: Standard
- 2: Premium'
format: int32
ErrorResponse:
type: object
properties:
errors:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ErrorInfo'
description: エラーリスト
additionalProperties: false
description: エラーレスポンス
ServerOsType:
enum:
- 1
- 2
type: integer
description: 'サーバーのOSの種類を指定します。指定値とOSの種類の対応は次の通りです。
- 1: Windows
- 2: Linux'
format: int32
DeploymentStatus:
type: object
properties:
id:
type:
- string
- 'null'
description: デプロイメントの一意の識別子。
name:
type:
- string
- 'null'
description: デプロイメントの名前。
type:
type:
- string
- 'null'
description: デプロイメントのタイプ。
properties:
$ref: '#/components/schemas/DeploymentStatusProperties'
additionalProperties: false
description: デプロイメントステータスのレスポンスを表します。
FrontDoorOriginGroup:
required:
- origin
type: object
properties:
origin:
$ref: '#/components/schemas/FrontDoorOrigin'
additionalProperties: false
description: 配信元グループ
ListResourcesResponse:
type: object
properties:
resources:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ResourceGroupResource'
description: リソースグループ一覧
additionalProperties: false
PostDeploymentResponse:
type: object
properties:
resourceGroupName:
type:
- string
- 'null'
description: リソースグループ名を取得します。
deploymentName:
type:
- string
- 'null'
description: デプロイメント名を取得します。
additionalProperties: false
description: デプロイメントが投稿された後に受け取るレスポンスを表します。
FrontDoorEndpoint:
required:
- route
type: object
properties:
route:
$ref: '#/components/schemas/FrontDoorRoute'
additionalProperties: false
description: Front Doorのエンドポイント
WafRequestBody:
required:
- endpoint
- location
- profile
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
profile:
$ref: '#/components/schemas/FrontDoorProfile'
endpoint:
$ref: '#/components/schemas/FrontDoorEndpoint'
additionalProperties: false
description: セキュリティ機能 WAFサービスの作成APIで受信するリクエストボディを表します。
CreatedByType:
type: object
additionalProperties: false
VulnerabilityRequestBody:
required:
- location
- os
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
os:
$ref: '#/components/schemas/ServerOsType'
additionalProperties: false
description: セキュリティ機能 脆弱性診断サービスの作成APIで受信するリクエストボディを表します。
ResourceType:
type: object
properties:
namespace:
type:
- string
- 'null'
readOnly: true
type:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
AzureLocation:
type: object
properties:
name:
type:
- string
- 'null'
readOnly: true
displayName:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
FrontDoorProfile:
required:
- level
type: object
properties:
level:
$ref: '#/components/schemas/PricingLevel'
levelNameOfBicepParameter:
type:
- string
- 'null'
description: Azure Front Doorの価格レベルのBicepテンプレートパラメーター名を取得します。
readOnly: true
additionalProperties: false
description: Front Doorのプロファイル
ResourceIdentifier:
type: object
properties:
resourceType:
$ref: '#/components/schemas/ResourceType'
name:
type:
- string
- 'null'
readOnly: true
parent:
$ref: '#/components/schemas/ResourceIdentifier'
subscriptionId:
type:
- string
- 'null'
readOnly: true
provider:
type:
- string
- 'null'
readOnly: true
location:
$ref: '#/components/schemas/AzureLocation'
resourceGroupName:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
FrontDoorRoute:
required:
- originGroup
- patterns
type: object
properties:
patterns:
type: array
items:
type: string
description: 'Front Doorルートのパスパターンを指定します。
パターンの先頭はスラッシュ (/) にする必要があります。アスタリスクは末尾のみで使用でき、アスタリスクの前はスラッシュ (/*) にする必要があります 。'
originGroup:
$ref: '#/components/schemas/FrontDoorOriginGroup'
additionalProperties: false
description: Front Doorルート
DeploymentStatusProperties:
type: object
properties:
provisioningState:
type:
- string
- 'null'
description: リソースのプロビジョニング状態。
timestamp:
type: string
description: デプロイメントステータスのタイムスタンプ。
format: date-time
additionalProperties: false
description: デプロイメントステータスのプロパティを表します。
ErrorInfo:
type: object
properties:
code:
type:
- string
- 'null'
description: エラーコード
message:
type:
- string
- 'null'
description: エラーメッセージ
additionalProperties: false
description: エラー情報
ResourceGroupData:
type: object
properties:
id:
$ref: '#/components/schemas/ResourceIdentifier'
name:
type:
- string
- 'null'
readOnly: true
resourceType:
$ref: '#/components/schemas/ResourceType'
systemData:
$ref: '#/components/schemas/SystemData'
tags:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
readOnly: true
location:
$ref: '#/components/schemas/AzureLocation'
resourceGroupProvisioningState:
type:
- string
- 'null'
readOnly: true
managedBy:
type:
- string
- 'null'
additionalProperties: false
GetResourceResponse:
type: object
properties:
data:
description: データ
url:
type:
- string
- 'null'
description: 管理ポータルのURL
additionalProperties: false
description: リソース個別取得APIのレスポンス
FrontDoorOrigin:
required:
- hostHeader
- hostName
type: object
properties:
hostName:
maxLength: 100
minLength: 1
type: string
description: '配信元のホスト名を指定します。
ホスト名は、有効なドメイン名、IPv4、または IPv6 である必要があります。'
hostHeader:
maxLength: 100
minLength: 1
type: string
description: '配信元のホストヘッダーを指定します。
ホストヘッダーは、有効なドメイン名、IPv4、または IPv6 である必要があります。'
additionalProperties: false
description: 配信元
SearchPostRequestBody:
required:
- location
- partitionCount
- replicaCount
- sku
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
sku:
$ref: '#/components/schemas/SearchSku'
skuString:
type:
- string
- 'null'
description: Azure AI SearchのSKUのBicepパラメータ用文字列
readOnly: true
replicaCount:
maximum: 12
minimum: 1
type: integer
description: 'AI Searchのレプリカ数を指定します。
選択したSKUに応じて、指定可能な値は次の通りです。
- 1: 全SKUで指定可能
- 2, 3: Free 以外のSKUで指定可能
- 4 ~ 12: Free、Basic 以外のSKUで指定可能'
format: int32
partitionCount:
enum:
- '1'
- '2'
- '3'
- '4'
- '6'
- '12'
type: integer
description: 'AI Searchのパーティション数を指定します。
指定できる値は 1, 2, 3, 4, 6, 12 のいずれかです。
選択したSKUに応じて、指定可能な値は次の通りです。
- 1: 全SKUで指定可能
- 2, 3: Free 以外のSKUで指定可能
- 4, 6, 12: Free、Basic、Standard3HD 以外のSKUで指定可能
また、レプリカ数 × パーティション数は次の範囲にしてください。
- 1: SKUにFreeを指定する場合
- 1 ~ 9: SKUにBasicを指定する場合
- 1 ~ 36: Free、Basic 以外のSKUを指定する場合'
format: int32
additionalProperties: false
description: 検索機能の作成APIで受信するリクエストボディ
DatalakePostRequestBody:
required:
- location
- performance
- redundancy
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
performance:
$ref: '#/components/schemas/DataLakePerformance'
redundancy:
$ref: '#/components/schemas/DataLakeRedundancy'
accountType:
type:
- string
- 'null'
description: アカウントタイプ(パフォーマンスと冗長性の組み合わせ)
readOnly: true
additionalProperties: false
description: データレイク機能の作成APIで受信するリクエストボディ
QueryPostRequestBody:
required:
- location
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
additionalProperties: false
EtlPostRequestBody:
required:
- location
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
additionalProperties: false
DataLakePerformance:
enum:
- 1
- 2
type: integer
description: 'パフォーマンスを指定します。指定値とパフォーマンスの対応は次の通りです。
- 1: Standard
- 2: Premium'
format: int32
DatawarehousePostRequestBody:
required:
- location
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
additionalProperties: false
DataLakeRedundancy:
enum:
- 1
- 2
- 3
- 4
type: integer
description: '冗長性を指定します。指定値と冗長性の対応は次の通りです。
- 1: LRS(ローカル冗長ストレージ)
- 2: GRS(geo冗長ストレージ)
- 3: ZRS(ゾーン冗長ストレージ)
- 4: GZRS(geoゾーン冗長ストレージ)'
format: int32
StreamingRequestBody:
required:
- location
- unitCount
type: object
properties:
location:
minLength: 1
enum:
- japaneast
type: string
description: デプロイ先のリージョン
example: japaneast
unitCount:
minLength: 1
type: string
description: 'Stream Analyticsのストリーミングユニット数を指定します。
指定値と実際のユニット数の対応は次の通りです。
- 3: 1/3ユニット
- 7: 2/3ユニット
- 10 ~ 660: 1 ~ 66ユニット(※)
※ 10 以上を指定する場合は、作成したいユニット数 × 10 の値を指定してください。指定できるのは 10 の倍数のみです。11 など 10 の倍数でない値を指定した場合はエラーとなります。'
additionalProperties: false
SearchSku:
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
description: 'AI SearchのSKUを指定します。
指定値とSKUの対応は次の通りです。
- 1: Free
- 2: Basic
- 3: Standard
- 4: Standard2
- 5: Standard3
- 6: Standard3HD
- 7: StorageOptimizedL1
- 8: StorageOptimizedL2'
format: int32
Name:
type: string
description: Unicode文字、数字、ハイフン、アンダースコア、ピリオドのみ許可
minLength: 1
maxLength: 255
example: name
pattern: ^[\p{L}\p{N}._\-]+$
Tags:
type: array
description: エンティティを検索するためのタグ
example:
- tag1
- tag2
items:
type: string
minLength: 1
maxLength: 255
pattern: ^[^\/\s\u3000]+$
Model:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
example: b69f7bfe-1d8f-48bb-8b85-b47359366e48
description: Entityを識別するためのID
createdAt:
type: string
format: date-time
readOnly: true
description: 作成日時
updatedAt:
type: string
format: date-time
readOnly: true
description: 更新日時
description: 各Entity共通のモデル
Group:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
$ref: '#/components/schemas/Name'
example: group1
tags:
$ref: '#/components/schemas/Tags'
description: Groupを検索するためのタグ
required:
- name
ErrorSchema:
type: object
properties:
message:
type: string
description: 各エラーに対応したメッセージが返却される
example: Bad Request
SubscriptionService:
type: object
properties:
id:
type: string
format: uuid
description: 現在契約と紐づいているServiceのID
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
name:
type: string
description: 現在契約と紐づいているService名
example: serviceName
required:
- id
- name
SubscriptionDetail:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
$ref: '#/components/schemas/Name'
example: 契約1
description: ユーザ識別用契約名
resourceId:
type: integer
format: int64
description: 契約を一意に識別するリソースID
example: 123456789012
monthlyRequest:
type: integer
description: 今月のリクエスト累計数
example: 15000
service:
type: object
$ref: '#/components/schemas/SubscriptionService'
description: 契約に紐づくServiceの情報
SubscriptionDetailResponse:
type: object
allOf:
- $ref: '#/components/schemas/SubscriptionDetail'
- properties:
plan:
$ref: '#/components/schemas/SubscriptionPlanResponse'
SubscriptionCreate:
type: object
properties:
planId:
type: string
format: uuid
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
description: プランID
name:
type: string
example: 契約1
description: 契約名
required:
- planId
- name
description: 契約情報
SubscriptionPlanResponse:
description: 料金プラン
type: object
allOf:
- properties:
planID:
type: string
format: uuid
description: プランID
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
planName:
type: string
description: プラン名
example: ベーシックプラン
price:
type: string
example: '1000'
description: 価格
maxServices:
type: integer
minimum: 0
description: 作成できるServiceの最大数
example: 10
maxRequests:
type: integer
minimum: 0
description: 追加料金なしで利用できるリクエスト数
example: 10000000
maxRequestsUnit:
type: string
enum:
- second
- minute
- hour
- day
- month
- year
description: maxRequestsの上限が適用される期間の単位
example: month
overage:
$ref: '#/components/schemas/Overage'
SubscriptionList:
properties:
subscriptions:
type: array
items:
$ref: '#/components/schemas/Subscription'
maxSubscription:
type: integer
description: 最大契約数
example: 5
Subscription:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
$ref: '#/components/schemas/Name'
example: 契約1
description: ユーザ識別用契約名
planId:
type: string
format: uuid
description: プランID
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
resourceId:
type: integer
format: int64
description: 契約を識別するためのID
example: 123456789012
monthlyRequest:
type: integer
description: 今月のリクエスト累計数
example: 15000
service:
type: object
$ref: '#/components/schemas/SubscriptionService'
description: 契約に紐づくServiceの情報
Overage:
type: object
properties:
unitRequests:
type: integer
minimum: 0
description: 超過リクエスト数単位
example: 1000000
unitPrice:
type: string
description: 超過リクエスト数単位の価格
example: '1000'
SubscriptionUpdate:
type: object
properties:
name:
type: string
example: 契約1
description: 契約名
required:
- name
Route:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
serviceId:
type: string
format: uuid
readOnly: true
example: 04c6abbd-0c12-42e5-8d90-7eea021028d9
name:
$ref: '#/components/schemas/Name'
example: routeName
tags:
$ref: '#/components/schemas/Tags'
description: Routeを検索するためのタグ
protocols:
type: string
enum:
- https
example: https
description: Routeにアクセスするためのプロトコル
path:
type: string
example: /
maxLength: 255
pattern: ^(\/|~\/).*
description: Routeにアクセスするためのパス
パスはスラッシュまたはチルダスラッシュで始まるパス文字列のみを許可
host:
readOnly: true
type: string
example: site-XXXXXXXXXXXXXXXX.XXX.apigw.sakura.ne.jp
description: 自動発行されたホスト
hostsに値が設定されていない場合に有効
hosts:
type: array
example:
- example.com
- example.jp
description: ホスト名
自動発行されたホストまたは設定したドメインを指定する
自動発行されたホストはService詳細照会APIで確認できる
作成したドメインはDomain一覧照会APIで確認できる
items:
type: string
description: ホスト名
自動発行されたホストまたは設定したドメインを指定する
自動発行されたホストはService詳細照会APIで確認できる
作成したドメインはDomain一覧照会APIで確認できる
example:
- example.com
- example.jp
methods:
type: array
items:
$ref: '#/components/schemas/HTTPMethod'
example:
- GET
- POST
default:
- GET
- POST
- PUT
- DELETE
- PATCH
- OPTIONS
- HEAD
- CONNECT
- TRACE
description: RouteにアクセスするためのHTTPメソッド
未指定の場合は全メソッドを許可
オブジェクトストレージ形式のサービスに紐づく場合は、GET・HEAD・OPTIONSメソッドのみを許可
httpsRedirectStatusCode:
type: integer
enum:
- 301
- 302
- 303
- 307
- 308
- 426
default: 426
example: 426
description: HTTPSリダイレクト時のステータスコード
regexPriority:
type: integer
minimum: 0
maximum: 255
default: 0
example: 0
description: パスを正規表現で指定した場合の優先度
0が最優先
stripPath:
type: boolean
default: true
example: false
description: リクエストのパスからルートのパスを削除するかどうか
preserveHost:
type: boolean
default: false
example: true
description: リクエストのHostヘッダーを保持するかどうか
requestBuffering:
type: boolean
default: true
example: false
description: リクエストのバッファリングを有効にするかどうか
responseBuffering:
type: boolean
default: true
example: false
description: レスポンスのバッファリングを有効にするかどうか
required:
- name
- protocols
- methods
RouteAuthorizationDetail:
type: object
oneOf:
- type: object
properties:
isACLEnabled:
type: boolean
enum:
- false
description: 認可設定を無効にする
required:
- isACLEnabled
- type: object
properties:
isACLEnabled:
type: boolean
enum:
- true
description: 認可設定を有効にする
groups:
type: array
description: 認可するGroupのリスト
items:
$ref: '#/components/schemas/RouteAuthorization'
minItems: 1
required:
- isACLEnabled
- groups
IpRestrictionConfig:
type: object
description: IP制限
allOf:
- properties:
protocols:
type: string
enum:
- https
example: https
description: IP制限を設定するプロトコル
restrictedBy:
type: string
enum:
- allowIps
- denyIps
example: allowIps
description: IP制限の種別
ips:
type: array
items:
type: string
pattern: ^(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)){3}$
minItems: 1
example:
- 192.168.1.1
- 192.168.1.2
description: 対象IPアドレス
IPアドレスはIPv4のみを許可
required:
- protocols
- restrictedBy
- ips
CorsConfig:
description: CORS設定
type: object
allOf:
- properties:
credentials:
type: boolean
description: ブラウザがクロスオリジンリクエストに対してクレデンシャルを含めるかどうか
example: false
accessControlExposedHeaders:
type: string
description: ブラウザがアクセス可能なヘッダー
maxLength: 4000
example: ''
accessControlAllowHeaders:
type: string
description: クライアントがリクエストに含めることができるヘッダー
maxLength: 4000
example: ''
maxAge:
type: integer
description: CORS許可の有効期限
format: int32
default: 0
example: 0
accessControlAllowMethods:
type: array
items:
$ref: '#/components/schemas/HTTPMethod'
example:
- GET
- POST
- PUT
- DELETE
- PATCH
- OPTIONS
- HEAD
- CONNECT
- TRACE
default:
- GET
- POST
- PUT
- DELETE
- PATCH
- OPTIONS
- HEAD
- CONNECT
- TRACE
description: CORS許可メソッド
未指定の場合は全メソッドを許可
accessControlAllowOrigins:
type: string
description: CORSで許可するOrigin
未指定の場合は全Originを許可
example: '*'
maxLength: 4000
preflightContinue:
type: boolean
description: CORSのPreflightリクエストを処理するかどうか
example: false
privateNetwork:
type: boolean
description: privateNetwork内で動作させるかどうか
example: false
HTTPMethod:
type: string
description: 変換するHTTPメソッド
enum:
- GET
- POST
- PUT
- DELETE
- PATCH
- OPTIONS
- HEAD
- CONNECT
- TRACE
Service:
description: Service情報
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
$ref: '#/components/schemas/Name'
description: Service名
Service名は半角英数字およびアンダースコアのみを許可
example: serviceName
tags:
$ref: '#/components/schemas/Tags'
description: Serviceを検索するためのタグ
protocol:
type: string
description: Serviceにアクセスするためのプロトコル
enum:
- http
- https
example: https
host:
type: string
description: Serviceにアクセスするためのホスト名
ホスト名はドメイン名またはIPアドレスを指定する
プライベート/ループバックIPアドレスは指定できない
maxLength: 253
pattern: ^((([a-zA-Z\d][a-zA-Z\d-]*[a-zA-Z\d]*\.)+[a-zA-Z]{2,})|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)))$
example: xxx.example.jp
path:
type: string
maxLength: 255
pattern: ^\/[a-zA-Z0-9_\-\/!.*'()-]*$
description: Serviceにアクセスするためのパス
パスは/から始まり、半角英数字、アンダースコア、ハイフン、スラッシュ、一部記号(!.*'()-)のみを許可
example: /base
default: /
port:
type: integer
minimum: 0
maximum: 65535
description: Serviceにアクセスするためのポート番号
省略した場合はプロトコルに応じたデフォルトポートが設定される
example: 80
retries:
type: integer
minimum: 0
maximum: 32767
default: 5
description: リトライ回数
connectTimeout:
type: integer
minimum: 1
maximum: 2147483646
default: 60000
description: 接続タイムアウト秒数
writeTimeout:
type: integer
minimum: 1
maximum: 2147483646
default: 60000
description: 書き込みタイムアウト秒数
readTimeout:
minimum: 1
maximum: 2147483646
type: integer
default: 60000
description: 読み込みタイムアウト秒数
authentication:
type: string
enum:
- none
- basic
- hmac
- jwt
- oidc
default: none
description: 認証方式
未指定の場合は認証なし
oidc:
$ref: '#/components/schemas/OidcSummary'
routeHost:
type: string
maxLength: 253
example: site-xxxxxxxxx.xxx.apigw.sakura.ne.jp
description: 自動発行したRouteのホスト
readOnly: true
required:
- name
- protocol
- host
JSONKey:
type: string
description: JSONのキー
半角英数字、ハイフン、アンダースコア、ピリオド繋ぎを許可
pattern: ^([a-zA-Z0-9_~\-\\\p{L}]+(\.[a-zA-Z0-9_~\-\\\p{L}]+)*)$
maxLength: 255
RequestRenameDetail:
type: object
properties:
headers:
type: array
items:
type: object
properties:
from:
$ref: '#/components/schemas/RequestHeaderKey'
to:
$ref: '#/components/schemas/RequestHeaderKey'
queryParams:
type: array
items:
type: object
properties:
from:
$ref: '#/components/schemas/QueryParamKey'
description: リネームするクエリパラメータのキー
to:
$ref: '#/components/schemas/QueryParamKey'
description: リネーム後のクエリパラメータのキー
body:
type: array
items:
type: object
properties:
from:
$ref: '#/components/schemas/JSONKey'
description: リネームするボディのキー
to:
$ref: '#/components/schemas/JSONKey'
description: リネーム後のボディのキー
QueryParamKey:
type: string
description: クエリパラメータのキー
半角英数字、ハイフン、アンダースコアのみを許可
pattern: ^[a-zA-Z0-9-_.]+$
maxLength: 255
QueryParamValue:
type: string
description: クエリパラメータの値
URLエンコードされた文字列
pattern: ^([\w\-._~!$&'()*+,;=:%]|%[0-9a-fA-F]{2})*$
maxLength: 255
ResponseModificationDetail:
type: object
properties:
ifStatusCode:
type: array
items:
type: integer
minimum: 100
maximum: 999
description: 特定のステータスコードの場合に追加する
headers:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/ResponseHeaderKey'
description: 追加するヘッダーのキー
value:
$ref: '#/components/schemas/RequestHeaderValue'
description: 追加するヘッダーの値
json:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/JSONKey'
description: 追加するJSONのキー
value:
type: string
description: 追加するJSONの値
OidcSummary:
description: OIDC認証要約情報
type: object
allOf:
- properties:
id:
type: string
format: uuid
description: Entityを識別するためのID
example: b69f7bfe-1d8f-48bb-8b85-b47359366e48
name:
type: string
description: OIDC認証名
example: OidcName
readOnly: true
ServiceDetail:
description: Service詳細情報
type: object
allOf:
- $ref: '#/components/schemas/Service'
- properties:
corsConfig:
$ref: '#/components/schemas/CorsConfig'
objectStorageConfig:
$ref: '#/components/schemas/ObjectStorageConfig'
RequestRemoveDetail:
type: object
properties:
headerKeys:
type: array
description: 削除するヘッダのキー
半角英数字、アンダースコア、ハイフンのみを許可
items:
$ref: '#/components/schemas/RequestHeaderKey'
queryParams:
type: array
description: 削除するクエリパラメータのキー
半角英数字、アンダースコア、ハイフンのみを許可
items:
$ref: '#/components/schemas/QueryParamKey'
body:
type: array
description: 削除するボディのキー
半角英数字、アンダースコア、ハイフンのみを許可
items:
$ref: '#/components/schemas/JSONKey'
ResponseAllowDetail:
type: object
description: 許可するJSONのキー
半角英数字、ハイフン、アンダースコア、ピリオド繋ぎを許可
properties:
jsonKeys:
type: array
items:
$ref: '#/components/schemas/JSONKey'
ResponseReplaceDetail:
type: object
properties:
ifStatusCode:
type: array
items:
type: integer
minimum: 100
maximum: 999
description: 特定のステータスコードの場合に置換する
headers:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/ResponseHeaderKey'
description: 置換するヘッダーのキー
value:
$ref: '#/components/schemas/RequestHeaderValue'
description: 置換後のヘッダーの値
json:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/JSONKey'
description: 置換するJSONのキー
value:
type: string
description: 置換後のJSONの値
body:
type: string
description: 置換するボディ
ObjectStorageConfig:
description: Object Storage設定
type: object
allOf:
- properties:
bucketName:
type: string
description: バケット名
example: my-bucket
pattern: ^[a-z0-9.\-]*$
folderName:
type: string
description: フォルダ名
example: my-folder
pattern: ^[a-zA-Z0-9_\-\/!.*'()]*$
endpoint:
type: string
description: S3互換のエンドポイントURL
example: s3.example.com
region:
type: string
description: S3互換のリージョン名
example: jp-north-1
accessKeyID:
type: string
description: アクセスキーID
example: XXXXXXXXXXXXXXXX
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
secretAccessKey:
type: string
description: シークレットアクセスキー
example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
useDocumentIndex:
type: boolean
description: ドキュメントインデックスを有効にするかどうか
default: true
required:
- bucketName
- endpoint
- region
- accessKeyID
- secretAccessKey
- useDocumentIndex
RouteDetail:
type: object
allOf:
- $ref: '#/components/schemas/Route'
- properties:
ipRestrictionConfig:
$ref: '#/components/schemas/IpRestrictionConfig'
ResponseRemoveDetail:
type: object
properties:
ifStatusCode:
type: array
items:
type: integer
minimum: 100
maximum: 999
description: 特定のステータスコードの場合に削除する
headerKeys:
type: array
description: 削除するヘッダのキー
半角英数字、ハイフンのみを許可
items:
$ref: '#/components/schemas/ResponseHeaderKey'
jsonKeys:
type: array
description: 削除するJSONのキー
半角英数字、ハイフン、アンダースコア、ピリオド繋ぎを許可
items:
$ref: '#/components/schemas/JSONKey'
ResponseRenameDetail:
type: object
properties:
ifStatusCode:
type: array
items:
type: integer
minimum: 100
maximum: 999
description: 特定のステータスコードの場合にリネームする
headers:
type: array
items:
type: object
description: リネームするヘッダーのキー
半角英数字、ハイフンのみを許可
properties:
from:
$ref: '#/components/schemas/ResponseHeaderKey'
to:
$ref: '#/components/schemas/ResponseHeaderKey'
json:
type: array
items:
type: object
properties:
from:
$ref: '#/components/schemas/JSONKey'
description: リネームするJSONのキー
to:
$ref: '#/components/schemas/JSONKey'
description: リネーム後のJSONのキー
ServiceDetailResponse:
description: Service情報
type: object
allOf:
- $ref: '#/components/schemas/ServiceDetail'
- properties:
subscription:
$ref: '#/components/schemas/ServiceSubscriptionResponse'
required:
- subscription
RequestAllowDetail:
type: object
properties:
body:
type: array
description: 許可するボディのキー
半角英数字、アンダースコア、ハイフンのみを許可
items:
$ref: '#/components/schemas/JSONKey'
RouteAuthorizationDetailResponse:
type: object
properties:
isACLEnabled:
type: boolean
enum:
- true
description: 認可設定が有効かどうか
groups:
type: array
description: 認可するGroupのリスト
items:
$ref: '#/components/schemas/RouteAuthorization'
minItems: 1
required:
- isACLEnabled
- groups
RequestModificationDetail:
type: object
properties:
headers:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/RequestHeaderKey'
description: 追加するヘッダのキー
value:
$ref: '#/components/schemas/RequestHeaderValue'
description: 追加するヘッダの値
queryParams:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/QueryParamKey'
description: 追加するクエリパラメータのキー
value:
$ref: '#/components/schemas/QueryParamValue'
description: 追加するクエリパラメータの値
body:
type: array
items:
type: object
properties:
key:
$ref: '#/components/schemas/JSONKey'
description: 追加するボディのキー
value:
type: string
description: 追加するボディの値
RouteAuthorization:
type: object
properties:
id:
type: string
description: GroupのEntityを識別するためのID
format: uuid
example: 1183b70d-70af-4e49-8af5-2a629b5c1b30
name:
$ref: '#/components/schemas/Name'
description: Group名
Group名はUnicode文字、数字、ハイフン、アンダースコア、ピリオド、チルダのみ許可
example: group1
enabled:
type: boolean
description: 対象の Group が許可されているかどうか
example: true
ResponseHeaderKey:
type: string
description: リクエストヘッダのキー
半角英数字、ハイフンのみを許可
pattern: ^[a-zA-Z0-9-]+$
maxLength: 255
RequestTransformation:
type: object
properties:
httpMethod:
$ref: '#/components/schemas/HTTPMethod'
allow:
$ref: '#/components/schemas/RequestAllowDetail'
remove:
$ref: '#/components/schemas/RequestRemoveDetail'
rename:
$ref: '#/components/schemas/RequestRenameDetail'
replace:
$ref: '#/components/schemas/RequestModificationDetail'
add:
$ref: '#/components/schemas/RequestModificationDetail'
append:
$ref: '#/components/schemas/RequestModificationDetail'
RequestHeaderValue:
type: string
description: リクエストヘッダの値
ASCII文字のみを許可
pattern: ^[\x20-\x7E]*$
maxLength: 255
RequestHeaderKey:
type: string
description: リクエストヘッダのキー
半角英数字、ハイフン、アンダースコアのみを許可
pattern: ^[a-zA-Z0-9-_]+$
maxLength: 255
ServiceSubscriptionResponse:
type: object
properties:
id:
type: string
format: uuid
description: サブスクリプションID
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
name:
type: string
description: サブスクリプション名
example: example-subscription-1
required:
- id
- name
ServiceDetailRequest:
description: Service登録リクエスト
type: object
allOf:
- $ref: '#/components/schemas/ServiceDetail'
- properties:
subscription:
$ref: '#/components/schemas/ServiceSubscriptionRequest'
required:
- subscription
ResponseTransformation:
type: object
properties:
allow:
$ref: '#/components/schemas/ResponseAllowDetail'
remove:
$ref: '#/components/schemas/ResponseRemoveDetail'
rename:
$ref: '#/components/schemas/ResponseRenameDetail'
replace:
$ref: '#/components/schemas/ResponseReplaceDetail'
add:
$ref: '#/components/schemas/ResponseModificationDetail'
append:
$ref: '#/components/schemas/ResponseModificationDetail'
ServiceSubscriptionRequest:
type: object
properties:
id:
type: string
format: uuid
description: サブスクリプションID
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
required:
- id
Domain:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
domainName:
type: string
description: ドメイン名
ドメイン名はドメイン名形式を指定する
IPv4アドレス及びワイルドカード(*)を指定できない
大文字を含めることはできない
example: example.com
pattern: ^\s*(([a-z\d]([a-z\d-]*[a-z\d])?)\.)+([a-z\d-]{2,})(\.)?\s*$
certificateId:
type: string
format: uuid
description: 証明書のID
example: 1183b70d-70af-4e49-8af5-2a629b5c1b30
certificateName:
type: string
description: 証明書の識別名
example: certificateName
readOnly: true
- required:
- domainName
DomainDTO:
type: object
properties:
domains:
type: array
items:
$ref: '#/components/schemas/Domain'
DomainPUT:
type: object
properties:
certificateId:
type: string
format: uuid
description: 証明書のID
example: 1183b70d-70af-4e49-8af5-2a629b5c1b30
Plan:
description: 料金プラン
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
type: string
description: プラン名
example: ベーシックプラン
price:
type: string
example: '1000'
description: 価格
description:
type: string
example: description
description: プランの説明
maxServices:
type: integer
minimum: 0
description: 作成できるServiceの最大数
example: 1
maxRequests:
type: integer
minimum: 0
description: 追加料金なしで利用できるリクエスト数
example: 10000000
maxRequestsUnit:
type: string
enum:
- second
- minute
- hour
- day
- month
- year
description: maxRequestsの上限が適用される期間の単位
example: month
overage:
$ref: '#/components/schemas/Overage'
BasicAuth:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
userName:
type: string
description: ユーザ名
example: userName
password:
type: string
description: パスワード
example: password
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
- required:
- userName
- password
HmacAuth:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
userName:
type: string
description: ユーザ名
example: username
secret:
type: string
description: HMACのシークレット
example: secret
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
- required:
- userName
- secret
UserDetail:
type: object
allOf:
- $ref: '#/components/schemas/User'
- properties:
ipRestrictionConfig:
$ref: '#/components/schemas/IpRestrictionConfig'
UserGroupDetailUpdate:
type: object
allOf:
- properties:
isAssigned:
type: boolean
example: false
description: UserがGroupに所属しているかどうか
required:
- isAssigned
- oneOf:
- properties:
id:
type: string
format: uuid
example: 1183b70d-70af-4e49-8af5-2a629b5c1b34
description: GroupのID
required:
- id
- properties:
name:
$ref: '#/components/schemas/Name'
example: groupName
required:
- name
UserAuthentication:
type: object
properties:
basicAuth:
$ref: '#/components/schemas/BasicAuth'
jwt:
$ref: '#/components/schemas/Jwt'
hmacAuth:
$ref: '#/components/schemas/HmacAuth'
User:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
$ref: '#/components/schemas/Name'
example: user
customID:
type: string
description: カスタムID
example: example_custom_id_123456
groups:
readOnly: true
type: array
description: Userが所属しているGroupのリスト
items:
$ref: '#/components/schemas/Group'
tags:
$ref: '#/components/schemas/Tags'
description: Userを検索するためのタグ
required:
- name
UserGroupDetail:
type: object
properties:
id:
type: string
format: uuid
example: 1183b70d-70af-4e49-8af5-2a629b5c1b34
description: GroupのID
name:
$ref: '#/components/schemas/Name'
example: groupname
description: Group名
isAssigned:
type: boolean
example: false
description: UserがGroupに所属しているかどうか
required:
- id
- name
- isAssigned
Jwt:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
key:
type: string
description: JWTの署名キー
example: key
x-oapi-codegen-extra-tags:
mask: 'true'
secret:
type: string
description: JWTの署名シークレット
example: secret
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
algorithm:
type: string
description: JWTの署名アルゴリズム
enum:
- HS256
- HS384
- HS512
example: HS256
- required:
- key
- secret
- algorithm
GetCertificates:
allOf:
- $ref: '#/components/schemas/CertificateAutoIssueLimit'
- type: object
properties:
certificates:
type: array
items:
allOf:
- $ref: '#/components/schemas/Certificate'
- type: object
properties:
type:
type: string
description: 証明書のタイプ
enum:
- auto
- manual
example: auto
status:
type: string
description: 証明書の状態
enum:
- valid
- expired
- issuing
- renewing
- issuance_failed
- renewal_failed
example: valid
statusMessage:
type: string
description: 'status が issuance_failed・renewal_failed の場合、詳細なステータスメッセージが返却される。
'
sans:
type: array
description: '証明書の Subject Alternative Name (SAN) に設定するドメイン一覧 ワイルドカードドメイン(*.example.com)は指定不可
'
uniqueItems: true
items:
type: string
example:
- example1.com
- example2.com
CertificateDetails:
type: object
properties:
cert:
type: string
description: 証明書
改行コード(\n)はエスケープ文字に変換して指定する
example: '-----BEGIN CERTIFICATE-----
MIIDOTCCAiGgAwIBAgIUD8d5Ln4LX/3QxXjhYXDdsXDwcBYwDQYJKoZIhvcNAQEL
BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNTAyMTcwMjMwMzNaFw0zNTAy
MTUwMjMwMzNaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw
HwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB
AQUAA4IBDwAwggEKAoIBAQC4casKTZ7neLdesms1bhcCUsS/gmTcDHZkbHy6SDaV
CN6q11iTpq27o4+c5CCu+zkn1ND1PStGXzhTlFOOluzCB0J4seBnFy2T8HXsTy1G
UvjdwceJKHMzYbM695RdiVfcAqX7UUFjBEyHV6duoSXmoIIBqFoOyX8Oc3mzdtW2
bmq02COW+bU/3NPj5w1Swtz2o9YPXv4DGwHfdntLH+zW/ObgRaSQPqe2aXQEwl8P
0FJB5c+/enZg/pmvIOa5xQ2exWPIGcmEQRol9YW4B3cpXwaFAjtpMcb6zV/ZDquq
q//ErI1u4aeyNp3Gdr179tuntiY0jZ8KptsKZOToCeKZAgMBAAGjITAfMB0GA1Ud
DgQWBBQtOsKs2R2QB/J8XX5KpcVjXi7yIDANBgkqhkiG9w0BAQsFAAOCAQEAYD+M
xTAgjRQAgrmSZemIFTw80npS6LHGLFWjKvxlKWZ+2AFOVmVvyrD9Ls2kzaCkpiDQ
Fs6Kn3j7Ny37r91uJQK8qZJIcuSRp9+d0XhcIjmpI7bnhLJ9W0WH9GJzhAedYJev
gNVFbf+Ygva/32qcwVIu28df84OAonGQF2GQ5KFJ8KM+5itC87Kc6cLPh+lB/D7A
d9CSctSyU6aao1dY9UJszrokIhwtOrbYvisaLLzTrXhVx+IdZS8xT0WFiHhB7ZSC
chA9B5keAa2stjuH6tkWSxiF5wIuq29lNNpUvqpWQ2ySOc/doC18q6quSGQCYQM2
OaBp1GS0IjXB0xf4Hw==
-----END CERTIFICATE-----
'
pattern: ^-----BEGIN CERTIFICATE-----\r?\n(?:[A-Za-z0-9+/=\r\n]+)-----END CERTIFICATE-----\r?\n?$
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
key:
type: string
description: 秘密鍵
改行コード(\n)はエスケープ文字に変換して指定する
example: 'REDACTED_PRIVATE_KEY_EXAMPLE
'
writeOnly: true
x-oapi-codegen-extra-tags:
mask: 'true'
expiredAt:
type: string
format: date-time
description: 証明書の有効期限
example: '2022-12-31 23:59:59'
readOnly: true
Certificate:
type: object
allOf:
- $ref: '#/components/schemas/Model'
- properties:
name:
$ref: '#/components/schemas/Name'
description: 証明書の識別名
証明書名はUnicode文字、数字、ハイフン、アンダースコア、ピリオドのみ許可
example: certificateName
rsa:
type: object
description: RSA証明書情報
allOf:
- $ref: '#/components/schemas/CertificateDetails'
ecdsa:
type: object
description: ECDSA証明書情報
allOf:
- $ref: '#/components/schemas/CertificateDetails'
- anyOf:
- type: object
required:
- name
- rsa
- type: object
required:
- name
- ecdsa
- type: object
required:
- name
- rsa
- ecdsa
CertificateAutoIssueLimit:
type: object
properties:
autoIssueLimit:
type: integer
description: 自動発行可能な証明書の上限数
example: 5
CertificatesAcme:
type: object
properties:
name:
type: string
description: 証明書の識別名
証明書名はUnicode文字、数字、ハイフン、アンダースコア、ピリオドのみ許可
example: name
sans:
type: array
description: '証明書の Subject Alternative Name (SAN) に設定するドメイン一覧 ワイルドカードドメイン(*.example.com)は指定不可
'
uniqueItems: true
items:
type: string
example:
- example1.com
- example2.com
handler.readApplicationStatus:
type: object
x-go-name: HandlerReadApplicationOnlyStatus
x-ogen-name: HandlerReadApplicationOnlyStatus
required:
- status
- message
properties:
status:
description: アプリケーションステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
message:
description: ステータス失敗時のメッセージ
type: string
example: Failed to authenticate with the registry
handler.createApplication:
type: object
required:
- id
- name
- timeout_seconds
- port
- min_scale
- max_scale
- components
- status
- public_url
- resource_id
- created_at
properties:
id:
description: アプリケーションID
type: string
example: u8FXIJ2LVM3wXVyzOEi
name:
description: アプリケーション名
type: string
example: アプリケーション1
timeout_seconds:
description: アプリケーションの公開URLにアクセスして、インスタンスが起動してからレスポンスが返るまでの時間制限
type: integer
example: 60
default: 60
minimum: 1
maximum: 300
port:
description: アプリケーションがリクエストを待ち受けるポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
min_scale:
description: アプリケーション全体の最小スケール数
type: integer
example: 0
default: 0
minimum: 0
maximum: 10
max_scale:
description: アプリケーション全体の最大スケール数
type: integer
example: 2
default: 10
minimum: 1
maximum: 10
scale_target_concurrency:
description: アプリケーションのスケールの閾値の目安となる同時リクエスト数
type: integer
example: 100
default: 100
minimum: 50
maximum: 200
components:
description: アプリケーションのコンポーネント情報
type: array
items:
type: object
required:
- name
- max_cpu
- max_memory
- deploy_source
properties:
name:
description: コンポーネント名
type: string
example: コンポーネント1
max_cpu:
description: コンポーネントの最大vCPU数
type: string
example: '0.5'
max_memory:
description: コンポーネントの最大メモリ
type: string
example: 1Gi
deploy_source:
description: コンポーネントを構成するソース
type: object
properties:
container_registry:
description: コンテナレジストリ
type: object
required:
- image
properties:
image:
description: コンテナイメージ名
type: string
example: apprun-example.sakuracr.jp/helloworld:latest
server:
description: コンテナレジストリの認証に使用するサーバー名
type: string
example: apprun-example.sakuracr.jp
username:
description: コンテナレジストリの認証に使用するユーザー名
type: string
example: apprun
env:
$ref: '#/components/schemas/response.env'
secret:
$ref: '#/components/schemas/response.secret'
probe:
description: コンポーネントのプローブ設定
type:
- object
- 'null'
properties:
http_get:
description: HTTP Getプローブタイプ
type:
- object
- 'null'
required:
- path
- port
properties:
path:
description: HTTPサーバーへアクセスしプローブをチェックする際のパス
type: string
example: /healthz
port:
description: HTTPサーバーへアクセスしプローブをチェックする際のポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
headers:
type: array
items:
type: object
properties:
name:
description: ヘッダーフィールド名
type: string
example: Custom-Header
value:
description: ヘッダーフィールド値
type: string
example: Awesome
status:
description: アプリケーションステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
public_url:
description: 公開URL
type: string
example: https://fq1I4vpQkN1YiGp.apprun.sakura.ne.jp
resource_id:
description: リソースID
type: string
example: '100000000000'
created_at:
description: 作成日時
type: string
format: date-time
model.errors:
type: array
items:
type: object
required:
- domain
- reason
- message
properties:
domain:
type:
- string
- 'null'
example: global
reason:
type:
- string
- 'null'
example: required
message:
type:
- string
- 'null'
example: Login Required
location_type:
type:
- string
- 'null'
example: header
enum:
- header
- body
- query
- parameter
location:
type:
- string
- 'null'
example: Authorization
handler.patchApplication:
type: object
required:
- id
- name
- timeout_seconds
- port
- min_scale
- max_scale
- components
- status
- public_url
- resource_id
- updated_at
properties:
id:
description: アプリケーションID
type: string
example: u8FXIJ2LVM3wXVyzOEi
name:
description: アプリケーション名
type: string
example: アプリケーション1
timeout_seconds:
description: アプリケーションの公開URLにアクセスして、インスタンスが起動してからレスポンスが返るまでの時間制限
type: integer
example: 60
minimum: 1
maximum: 300
port:
description: アプリケーションがリクエストを待ち受けるポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
min_scale:
description: アプリケーション全体の最小スケール数
type: integer
example: 0
minimum: 0
maximum: 10
max_scale:
description: アプリケーション全体の最大スケール数
type: integer
example: 2
minimum: 1
maximum: 10
scale_target_concurrency:
description: アプリケーションのスケールの閾値の目安となる同時リクエスト数
type: integer
example: 100
minimum: 50
maximum: 200
components:
description: アプリケーションのコンポーネント情報
type: array
items:
type: object
required:
- name
- max_cpu
- max_memory
- deploy_source
properties:
name:
description: コンポーネント名
type: string
example: コンポーネント1
max_cpu:
description: コンポーネントの最大vCPU数
type: string
example: '0.5'
max_memory:
description: コンポーネントの最大メモリ
type: string
example: 1Gi
deploy_source:
description: コンポーネントを構成するソース
type: object
properties:
container_registry:
description: コンテナレジストリ
type: object
required:
- image
properties:
image:
description: コンテナイメージ名
type: string
example: apprun-example.sakuracr.jp/helloworld:latest
server:
description: コンテナレジストリの認証に使用するサーバー名
type: string
example: apprun-example.sakuracr.jp
username:
description: コンテナレジストリの認証に使用するユーザー名
type: string
example: apprun
env:
$ref: '#/components/schemas/response.env'
secret:
$ref: '#/components/schemas/response.secret'
probe:
description: コンポーネントのプローブ設定
type:
- object
- 'null'
properties:
http_get:
description: HTTP Getプローブタイプ
type:
- object
- 'null'
required:
- path
- port
properties:
path:
description: HTTPサーバーへアクセスしプローブをチェックする際のパス
type: string
example: /healthz
port:
description: HTTPサーバーへアクセスしプローブをチェックする際のポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
headers:
type: array
items:
type: object
properties:
name:
description: ヘッダーフィールド名
type: string
example: Custom-Header
value:
description: ヘッダーフィールド値
type: string
example: Awesome
status:
description: アプリケーションステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
public_url:
description: 公開URL
type: string
example: https://fq1I4vpQkN1YiGp.apprun.sakura.ne.jp
resource_id:
description: リソースID
type: string
example: '100000000000'
updated_at:
description: 更新日時
type: string
format: date-time
patchApplicationBody:
type: object
properties:
timeout_seconds:
description: アプリケーションの公開URLにアクセスして、インスタンスが起動してからレスポンスが返るまでの時間制限
type: integer
example: 60
minimum: 1
maximum: 300
port:
description: 'アプリケーションがリクエストを待ち受けるポート番号。
ただし、8012, 8013, 8022, 9090, 9091, 8008 は予約済みのため設定不可。
'
type: integer
example: 8080
minimum: 1
maximum: 65535
min_scale:
description: アプリケーション全体の最小スケール数
type: integer
example: 0
minimum: 0
maximum: 10
max_scale:
description: アプリケーション全体の最大スケール数
type: integer
example: 2
minimum: 1
maximum: 10
scale_target_concurrency:
description: アプリケーションのスケールの閾値の目安となる同時リクエスト数
type: integer
example: 100
minimum: 50
maximum: 200
components:
description: アプリケーションのコンポーネント情報
type: array
items:
type: object
required:
- name
- max_cpu
- max_memory
- deploy_source
properties:
name:
description: コンポーネント名
type: string
example: コンポーネント1
minLength: 1
maxLength: 255
max_cpu:
description: コンポーネントの最大vCPU数(メモリとの組み合わせで利用できない値もあります)
type: string
example: '0.5'
enum:
- '0.5'
- '1'
- '2'
max_memory:
description: コンポーネントの最大メモリ(vCPUとの組み合わせで利用できない値もあります)
type: string
example: 1Gi
enum:
- 1Gi
- 2Gi
- 4Gi
deploy_source:
description: コンポーネントを構成するソース
type: object
properties:
container_registry:
description: "コンテナレジストリ \n以下のレジストリを利用できます。\n* さくらのクラウドで提供中のコンテナレジストリ\n* Docker Hub\n* GitHub Container Registry\n"
type: object
required:
- image
properties:
image:
description: コンテナイメージ名
type: string
example: apprun-example.sakuracr.jp/helloworld:latest
minLength: 1
maxLength: 128
server:
description: 'コンテナレジストリのサーバー名(認証が必要な場合は入力してください)
Docker Hub利用時は `index.docker.io` を指定してください。
'
type:
- string
- 'null'
example: apprun-example.sakuracr.jp
minLength: 1
maxLength: 128
username:
description: コンテナレジストリのユーザー名(認証が必要な場合は入力してください)
type:
- string
- 'null'
example: apprun
minLength: 1
maxLength: 63
password:
description: "コンテナレジストリのパスワード(認証が必要な場合は入力してください) \n※ 認証にトークンを使用する場合は、この欄に入力してください。\n"
type:
- string
- 'null'
example: apprun
minLength: 1
maxLength: 63
action:
$ref: '#/components/schemas/containerRegistryAction'
env:
$ref: '#/components/schemas/request.env'
secret:
description: コンポーネントに渡す環境変数(機密情報の設定に使用可能)
type:
- array
- 'null'
items:
type: object
required:
- key
properties:
key:
description: '環境変数名。
ただし、K_SERVICE, K_CONFIGURATION, K_REVISION, PORTは予約済みのため設定不可。
'
type: string
example: MY_SECRET
value:
description: 環境変数の値。valueを指定しない場合は、最新のバージョンで保存された値が使用されます。
type: string
example: my_secret_value
probe:
description: コンポーネントのプローブ設定
type:
- object
- 'null'
properties:
http_get:
description: HTTP Getプローブタイプ
type:
- object
- 'null'
required:
- path
- port
properties:
path:
description: HTTPサーバーへアクセスしプローブをチェックする際のパス
type: string
example: /healthz
port:
description: 'HTTPサーバーへアクセスしプローブをチェックする際のポート番号。
ただし、8012, 8013, 8022, 9090, 9091, 8008 は予約済みのため設定不可。
'
type: integer
example: 8080
minimum: 1
maximum: 65535
headers:
type: array
items:
type: object
properties:
name:
description: ヘッダーフィールド名
type: string
example: Custom-Header
value:
description: ヘッダーフィールド値
type: string
example: Awesome
all_traffic_available:
description: アプリケーションを最新のバージョンにすべてのトラフィックを割り当てるかどうか
type: boolean
containerRegistryAction:
description: 'コンテナレジストリの認証情報の設定方法
* new: 指定された認証情報を使用します。
* keep: 最新のバージョンで保存された認証情報を使用します。
'
type:
- string
- 'null'
default: new
enum:
- new
- keep
response.env:
description: コンポーネントに渡す環境変数
type: array
items:
type: object
required:
- key
- value
properties:
key:
description: 環境変数名
type: string
example: MY_ENV
value:
description: 環境変数の値
type: string
example: my_value
createApplicationBody:
type: object
required:
- name
- timeout_seconds
- port
- min_scale
- max_scale
- components
properties:
name:
description: アプリケーション名
type: string
example: アプリケーション1
minLength: 1
maxLength: 255
timeout_seconds:
description: アプリケーションの公開URLにアクセスして、インスタンスが起動してからレスポンスが返るまでの時間制限
type: integer
example: 60
default: 60
minimum: 1
maximum: 300
port:
description: 'アプリケーションがリクエストを待ち受けるポート番号。
ただし、8012, 8013, 8022, 9090, 9091, 8008 は予約済みのため設定不可。
'
type: integer
example: 8080
minimum: 1
maximum: 65535
min_scale:
description: アプリケーション全体の最小スケール数
type: integer
example: 0
default: 0
minimum: 0
maximum: 10
max_scale:
description: アプリケーション全体の最大スケール数
type: integer
example: 2
default: 10
minimum: 1
maximum: 10
scale_target_concurrency:
description: アプリケーションのスケールの閾値の目安となる同時リクエスト数
type: integer
example: 100
default: 100
minimum: 50
maximum: 200
components:
description: アプリケーションのコンポーネント情報
type: array
items:
type: object
required:
- name
- max_cpu
- max_memory
- deploy_source
properties:
name:
description: コンポーネント名
type: string
example: コンポーネント1
minLength: 1
maxLength: 255
max_cpu:
description: コンポーネントの最大vCPU数(メモリとの組み合わせで利用できない値もあります)
type: string
example: '0.5'
enum:
- '0.5'
- '1'
- '2'
max_memory:
description: コンポーネントの最大メモリ(vCPUとの組み合わせで利用できない値もあります)
type: string
example: 1Gi
enum:
- 1Gi
- 2Gi
- 4Gi
deploy_source:
description: コンポーネントを構成するソース
type: object
properties:
container_registry:
description: "コンテナレジストリ \n以下のレジストリを利用できます。\n* さくらのクラウドで提供中のコンテナレジストリ\n* Docker Hub\n* GitHub Container Registry\n"
type: object
required:
- image
properties:
image:
description: コンテナイメージ名
type: string
example: apprun-example.sakuracr.jp/helloworld:latest
minLength: 1
maxLength: 128
server:
description: "コンテナレジストリのサーバー名(認証が必要な場合は入力してください) \nDocker Hub利用時は `index.docker.io` を指定してください。\n"
type:
- string
- 'null'
example: apprun-example.sakuracr.jp
minLength: 1
maxLength: 128
username:
description: コンテナレジストリのユーザー名(認証が必要な場合は入力してください)
type:
- string
- 'null'
example: apprun
minLength: 1
maxLength: 63
password:
description: "コンテナレジストリのパスワード(認証が必要な場合は入力してください) \n※ 認証にトークンを使用する場合は、この欄に入力してください。\n"
type:
- string
- 'null'
example: apprun
minLength: 1
maxLength: 63
env:
$ref: '#/components/schemas/request.env'
secret:
description: コンポーネントに渡す環境変数(機密情報の設定に使用可能)
type:
- array
- 'null'
items:
type: object
required:
- key
- value
properties:
key:
description: '環境変数名。
ただし、K_SERVICE, K_CONFIGURATION, K_REVISION, PORTは予約済みのため設定不可。
'
type: string
example: MY_SECRET
value:
description: 環境変数の値
type: string
example: my_secret_value
probe:
description: コンポーネントのプローブ設定
type:
- object
- 'null'
properties:
http_get:
description: HTTP Getプローブタイプ
type:
- object
- 'null'
required:
- path
- port
properties:
path:
description: HTTPサーバーへアクセスしプローブをチェックする際のパス
type: string
example: /healthz
port:
description: 'HTTPサーバーへアクセスしプローブをチェックする際のポート番号。
ただし、8012, 8013, 8022, 9090, 9091, 8008 は予約済みのため設定不可。
'
type: integer
example: 8080
minimum: 1
maximum: 65535
headers:
type: array
items:
type: object
properties:
name:
description: ヘッダーフィールド名
type: string
example: Custom-Header
value:
description: ヘッダーフィールド値
type: string
example: Awesome
handler.readApplication:
type: object
required:
- id
- name
- timeout_seconds
- port
- min_scale
- max_scale
- components
- status
- public_url
- resource_id
- created_at
properties:
id:
description: アプリケーションID
type: string
example: u8FXIJ2LVM3wXVyzOEi
name:
description: アプリケーション名
type: string
example: アプリケーション1
timeout_seconds:
description: アプリケーションの公開URLにアクセスして、インスタンスが起動してからレスポンスが返るまでの時間制限
type: integer
example: 60
default: 60
minimum: 1
maximum: 300
port:
description: アプリケーションがリクエストを待ち受けるポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
min_scale:
description: アプリケーション全体の最小スケール数
type: integer
example: 0
default: 0
minimum: 0
maximum: 10
max_scale:
description: アプリケーション全体の最大スケール数
type: integer
example: 2
default: 10
minimum: 1
maximum: 10
scale_target_concurrency:
description: アプリケーションのスケールの閾値の目安となる同時リクエスト数
type: integer
example: 100
default: 100
minimum: 50
maximum: 200
components:
description: アプリケーションのコンポーネント情報
type: array
items:
type: object
required:
- name
- max_cpu
- max_memory
- deploy_source
properties:
name:
description: コンポーネント名
type: string
example: コンポーネント1
max_cpu:
description: コンポーネントの最大vCPU数
type: string
example: '0.5'
max_memory:
description: コンポーネントの最大メモリ
type: string
example: 1Gi
deploy_source:
description: コンポーネントを構成するソース
type: object
properties:
container_registry:
description: コンテナレジストリ
type: object
required:
- image
properties:
image:
description: コンテナイメージ名
type: string
example: apprun-example.sakuracr.jp/helloworld:latest
server:
description: コンテナレジストリの認証に使用するサーバー名
type: string
example: apprun-example.sakuracr.jp
username:
description: コンテナレジストリの認証に使用するユーザー名
type: string
example: apprun
env:
$ref: '#/components/schemas/response.env'
secret:
$ref: '#/components/schemas/response.secret'
probe:
description: コンポーネントのプローブ設定
type:
- object
- 'null'
properties:
http_get:
description: HTTP Getプローブタイプ
type:
- object
- 'null'
required:
- path
- port
properties:
path:
description: HTTPサーバーへアクセスしプローブをチェックする際のパス
type: string
example: /healthz
port:
description: HTTPサーバーへアクセスしプローブをチェックする際のポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
headers:
type: array
items:
type: object
properties:
name:
description: ヘッダーフィールド名
type: string
example: Custom-Header
value:
description: ヘッダーフィールド値
type: string
example: Awesome
status:
description: アプリケーションステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
public_url:
description: 公開URL
type: string
example: https://fq1I4vpQkN1YiGp.apprun.sakura.ne.jp
resource_id:
description: リソースID
type: string
example: '100000000000'
created_at:
description: 作成日時
type: string
format: date-time
response.secret:
description: コンポーネントに渡す環境変数(レスポンスに値は表示されません)
type: array
items:
type: object
required:
- key
properties:
key:
description: 環境変数名
type: string
example: MY_SECRET
request.env:
description: コンポーネントに渡す環境変数
type:
- array
- 'null'
items:
type: object
required:
- key
- value
properties:
key:
description: '環境変数名。
ただし、K_SERVICE, K_CONFIGURATION, K_REVISION, PORTは予約済みのため設定不可。
'
type: string
example: MY_ENV
value:
description: 環境変数の値
type: string
example: my_value
model.defaultError:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: integer
example: 401
message:
type: string
example: Login Required
errors:
$ref: '#/components/schemas/model.errors'
model.cloudctrlError:
type: object
required:
- is_fatal
- serial
- status
- error_code
- error_msg
properties:
is_fatal:
type: boolean
example: true
serial:
type: string
example: abcdefghijklmnopqrstuvwxyz0123456789
status:
type: string
example: 403 Forbidden
error_code:
type: string
example: access_no_permission
error_msg:
type: string
example: 要求された操作は許可されていません。このユーザに設定されたアクセス権限により、このゾーンまたは機能へのアクセスは禁止されています。
handler.listApplications:
type: object
required:
- meta
- data
properties:
meta:
type: object
required:
- page_num
- page_size
- object_total
- sort_field
- sort_order
properties:
page_num:
type: integer
example: 1
page_size:
type: integer
example: 100
object_total:
type: integer
example: 1000
sort_field:
type: string
example: created_at
sort_order:
type: string
example: asc
enum:
- asc
- desc
data:
type: array
items:
type: object
required:
- id
- name
- status
- public_url
- created_at
properties:
id:
description: アプリケーションID
type: string
example: u8FXIJ2LVM3wXVyzOEi
name:
description: アプリケーション名
type: string
example: アプリケーション1
status:
description: アプリケーションステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
public_url:
description: 公開URL
type: string
example: https://fq1I4vpQkN1YiGp.apprun.sakura.ne.jp
created_at:
description: 作成日時
type: string
format: date-time
handler.updateTraffic:
type: object
required:
- data
- meta
properties:
meta:
type:
- object
- 'null'
example: null
data:
type: array
items:
type: object
required:
- version_name
- is_latest_version
- percent
properties:
version_name:
description: バージョン名
type: string
example: Version1
is_latest_version:
description: 最新バージョンかどうか
type: boolean
percent:
description: トラフィック分散の割合
type: integer
example: 100
updateTrafficBody:
type: array
items:
oneOf:
- type: object
required:
- is_latest_version
- percent
properties:
is_latest_version:
description: 最新バージョンかどうか
type: boolean
percent:
description: トラフィック分散の割合
type: integer
- type: object
required:
- version_name
- percent
properties:
version_name:
description: バージョン名
type: string
example: Version1
percent:
description: トラフィック分散の割合
type: integer
handler.listTraffic:
type: object
required:
- data
properties:
meta:
type:
- object
- 'null'
example: null
data:
type: array
items:
type: object
required:
- version_name
- is_latest_version
- percent
properties:
version_name:
description: バージョン名
type: string
example: Version1
is_latest_version:
description: 最新バージョンかどうか
type: boolean
percent:
description: トラフィック分散の割合
type: integer
example: 100
handler.readVersionStatus:
type: object
x-go-name: HandlerReadApplicationVersionOnlyStatus
x-ogen-name: HandlerReadApplicationVersionOnlyStatus
required:
- status
- message
properties:
status:
description: アプリケーションバージョンステータス
type: string
example: UnHealthy
enum:
- Healthy
- UnHealthy
- Deploying
message:
description: ステータス失敗時のメッセージ
type: string
example: Failed to authenticate with the registry
handler.listVersions:
type: object
required:
- meta
- data
properties:
meta:
type: object
required:
- page_num
- page_size
- object_total
- sort_field
- sort_order
properties:
page_num:
type: integer
example: 1
page_size:
type: integer
example: 100
object_total:
type: integer
example: 1000
sort_field:
type: string
example: created_at
sort_order:
type: string
example: asc
enum:
- asc
- desc
data:
type: array
items:
type: object
required:
- id
- name
- status
- created_at
properties:
id:
description: バージョンID
type: string
example: BIi7jHVWGjg7NaxcK
name:
description: バージョン名
type: string
example: version-001
status:
description: ステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
created_at:
description: 作成日時
type: string
format: date-time
handler.readVersion:
type: object
required:
- id
- name
- min_scale
- max_scale
- timeout_seconds
- port
- status
- created_at
- components
properties:
id:
description: バージョンID
type: string
example: BIi7jHVWGjg7NaxcK
name:
description: バージョン名
type: string
example: version-001
status:
description: バージョンステータス
type: string
example: Healthy
enum:
- Healthy
- UnHealthy
- Deploying
timeout_seconds:
description: アプリケーションの公開URLにアクセスして、インスタンスが起動してからレスポンスが返るまでの時間制限
type: integer
example: 60
default: 60
minimum: 1
maximum: 300
port:
description: アプリケーションがリクエストを待ち受けるポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
min_scale:
description: バージョンの最小スケール数
type: integer
example: 0
default: 0
minimum: 0
maximum: 10
max_scale:
description: バージョンの最大スケール数
type: integer
example: 2
default: 10
minimum: 1
maximum: 10
scale_target_concurrency:
description: バージョンのスケールの閾値の目安となる同時リクエスト数
type: integer
example: 100
default: 100
minimum: 50
maximum: 200
components:
description: バージョンのコンポーネント情報
type: array
items:
type: object
required:
- name
- max_cpu
- max_memory
- deploy_source
properties:
name:
description: コンポーネント名
type: string
example: コンポーネント1
max_cpu:
description: コンポーネントの最大vCPU数
type: string
example: '0.5'
max_memory:
description: コンポーネントの最大メモリ
type: string
example: 1Gi
deploy_source:
description: コンポーネントを構成するソース
type: object
properties:
container_registry:
description: コンテナレジストリ
type: object
required:
- image
properties:
image:
description: コンテナイメージ名
type: string
example: apprun-example.sakuracr.jp/helloworld:latest
server:
description: コンテナレジストリの認証に使用するサーバー名
type: string
example: apprun-example.sakuracr.jp
username:
description: コンテナレジストリの認証に使用するユーザー名
type: string
example: apprun
env:
$ref: '#/components/schemas/response.env'
secret:
$ref: '#/components/schemas/response.secret'
probe:
description: コンポーネントのプローブ設定
type:
- object
- 'null'
properties:
http_get:
description: HTTP Getプローブタイプ
type:
- object
- 'null'
required:
- path
- port
properties:
path:
description: HTTPサーバーへアクセスしプローブをチェックする際のパス
type: string
example: /healthz
port:
description: HTTPサーバーへアクセスしプローブをチェックする際のポート番号
type: integer
example: 8080
minimum: 1
maximum: 65535
headers:
type: array
items:
type: object
properties:
name:
description: ヘッダーフィールド名
type: string
example: Custom-Header
value:
description: ヘッダーフィールド値
type: string
example: Awesome
created_at:
description: 作成日時
type: string
format: date-time
handler.readPacketFilter:
type: object
required:
- is_enabled
- settings
properties:
is_enabled:
type: boolean
description: 有効フラグ
example: true
settings:
type: array
maxItems: 10
items:
required:
- from_ip
- from_ip_prefix_length
properties:
from_ip:
type: string
description: 送信元IPv4アドレス
example: 0.0.0.0
from_ip_prefix_length:
type: integer
description: IPv4アドレスprefix長
minimum: 0
maximum: 32
example: 0
handler.patchPacketFilter:
type: object
required:
- is_enabled
- settings
properties:
is_enabled:
type: boolean
description: 有効フラグ
example: true
settings:
type: array
maxItems: 10
items:
required:
- from_ip
- from_ip_prefix_length
properties:
from_ip:
type: string
description: 送信元IPv4アドレス
example: 0.0.0.0
from_ip_prefix_length:
type: integer
description: IPv4アドレスprefix長
example: 0
patchPacketFilterBody:
type: object
properties:
is_enabled:
type: boolean
description: 有効フラグ
example: true
settings:
type: array
maxItems: 10
items:
required:
- from_ip
- from_ip_prefix_length
properties:
from_ip:
type: string
description: 送信元IPv4アドレス
example: 0.0.0.0
from_ip_prefix_length:
type: integer
description: IPv4アドレスprefix長
example: 0
handler.readUser:
type: object
required:
- limit
properties:
limit:
type: object
required:
- application_count
properties:
application_count:
description: プロジェクトで作成できるアプリケーション数の上限
type: integer
example: 5
handler.createUser:
type: object
required:
- limit
properties:
limit:
type: object
required:
- application_count
properties:
application_count:
description: プロジェクトで作成できるアプリケーション数の上限
type: integer
example: 5
LogMeasureRuleModel:
properties:
version:
$ref: '#/components/schemas/LogMeasureRuleVersionEnum'
query:
$ref: '#/components/schemas/LogMeasureRuleV1'
required:
- version
- query
title: LogMeasureRuleModel
type: object
AlertRule:
type: object
properties:
uid:
type: string
format: uuid
readOnly: true
project_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
readOnly: true
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
name:
type: string
maxLength: 256
query:
type: string
maxLength: 4096
format:
type: string
maxLength: 256
template:
type: string
maxLength: 256
open:
type: boolean
readOnly: true
enabled_warning:
type: boolean
enabled_critical:
type: boolean
threshold_warning:
type:
- string
- 'null'
maxLength: 256
threshold_critical:
type:
- string
- 'null'
maxLength: 256
threshold_duration_warning:
type: integer
format: int64
title: Threshold duration
threshold_duration_critical:
type: integer
format: int64
required:
- metrics_storage_id
- open
- project_id
- query
- uid
MetricsStorage:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
is_system:
type: boolean
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
endpoints:
type: object
properties:
address:
type: string
required:
- address
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
updated_at:
type: string
format: date-time
readOnly: true
title: Update datetime
usage:
type: object
properties:
metrics_routings:
type: integer
alert_rules:
type: integer
log_measure_rules:
type: integer
required:
- metrics_routings
- alert_rules
- log_measure_rules
readOnly: true
required:
- account_id
- created_at
- endpoints
- icon
- id
- is_system
- resource_id
- tags
- updated_at
- usage
Operator4:
enum:
- eq
- ne
- gt
- lt
- gte
- lte
- multi-eq
title: Operator4
type: string
Operator2:
enum:
- eq
- ne
title: Operator2
type: string
NumberFieldName:
enum:
- http_request_size
- http_status
- http_response_size
- http_remote_port
- http_latency_ns
- http_cache_fill_bytes
- sakuracloud_resource
- resource_dropped_attributes_count
- dropped_attributes_count
- span_duration_unix_nano
title: NumberFieldName
type: string
MatchLabelsItem:
type: object
properties:
name:
type: string
maxLength: 256
value:
type: string
maxLength: 256
required:
- name
- value
PaginatedLogMeasureRuleList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/LogMeasureRule'
NotificationTargetRequest:
type: object
properties:
service_type:
enum:
- SAKURA_SIMPLE_NOTICE
- SAKURA_EVENT_BUS
type: string
description: '* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification
* `SAKURA_EVENT_BUS` - Sakura cloud event bus'
x-spec-enum-id: 3b143ded19bdc92e
url:
type: string
maxLength: 1024
description:
type: string
maxLength: 100
required:
- service_type
Operator:
enum:
- eq
- ne
- gt
- lt
- gte
- lte
- multi-eq
- like
- ilike
title: Operator
type: string
MatchLabelsItemRequest:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 256
value:
type: string
minLength: 1
maxLength: 256
required:
- name
- value
OrMatcher:
properties:
type:
title: Type
type: string
enum:
- or
matchers:
items:
$ref: '#/components/schemas/FieldMatcher'
title: Matchers
type: array
required:
- type
- matchers
title: OrMatcher
type: object
AndMatcher:
properties:
type:
title: Type
type: string
enum:
- and
matchers:
items:
$ref: '#/components/schemas/FieldMatcher'
title: Matchers
type: array
required:
- type
- matchers
title: AndMatcher
type: object
NotificationRoutingRequest:
type: object
properties:
notification_target_uid:
type: string
format: uuid
writeOnly: true
match_labels:
type: array
items:
$ref: '#/components/schemas/MatchLabelsItemRequest'
resend_interval_minutes:
type: integer
maximum: 720
minimum: 0
required:
- match_labels
- notification_target_uid
AlertProject:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
required:
- account_id
- created_at
- icon
- id
- resource_id
- tags
FieldModel:
enum:
- severity
title: FieldModel
type: string
MapKeyExistsMatcher:
properties:
type:
title: Type
type: string
enum:
- map-key-exists
field:
$ref: '#/components/schemas/MapFieldName'
key:
title: Key
type: string
required:
- type
- field
- key
title: MapKeyExistsMatcher
type: object
AlertRuleRequest:
type: object
properties:
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
name:
type: string
maxLength: 256
query:
type: string
minLength: 1
maxLength: 4096
format:
type: string
maxLength: 256
template:
type: string
maxLength: 256
enabled_warning:
type: boolean
enabled_critical:
type: boolean
threshold_warning:
type:
- string
- 'null'
minLength: 1
maxLength: 256
threshold_critical:
type:
- string
- 'null'
minLength: 1
maxLength: 256
threshold_duration_warning:
type: integer
format: int64
title: Threshold duration
threshold_duration_critical:
type: integer
format: int64
required:
- metrics_storage_id
- query
LogStorage:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
expire_day:
type: integer
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
endpoints:
type: object
properties:
ingester:
type: object
properties:
address:
type: string
insecure:
type: boolean
required:
- address
required:
- ingester
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
is_system:
type: boolean
readOnly: true
classification:
type: string
enum:
- shared
- dedicated
readOnly: true
kms_key_id:
type:
- integer
- 'null'
readOnly: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
service_principal_id:
type:
- integer
- 'null'
format: int64
usage:
type: object
properties:
log_routings:
type: integer
log_measure_rules:
type: integer
required:
- log_routings
- log_measure_rules
readOnly: true
required:
- account_id
- classification
- created_at
- endpoints
- expire_day
- icon
- id
- is_system
- kms_key_id
- resource_id
- tags
- usage
PaginatedNotificationTargetList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/NotificationTarget'
WrappedAlertProject:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
is_ok:
type: boolean
required:
- account_id
- created_at
- icon
- id
- is_ok
- resource_id
- tags
MapValueNumMatcher:
properties:
type:
title: Type
type: string
enum:
- map-value-number
operator:
$ref: '#/components/schemas/Operator4'
field:
$ref: '#/components/schemas/MapFieldName'
key:
title: Key
type: string
value:
title: Value
type: number
format: double
value_list:
description: use only multi-eq
items:
type: number
format: double
title: Value List
type: array
required:
- type
- operator
- field
- key
- value
- value_list
title: MapValueNumMatcher
type: object
LogMeasureRuleVersionEnum:
enum:
- v1
title: LogMeasureRuleVersionEnum
type: string
PaginatedAlertProjectList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/AlertProject'
LogMeasureRuleModelRequest:
properties:
version:
$ref: '#/components/schemas/LogMeasureRuleVersionEnum'
query:
$ref: '#/components/schemas/LogMeasureRuleV1'
required:
- version
- query
title: LogMeasureRuleModel
type: object
PaginatedHistoryList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/History'
LogMeasureRuleRequest:
type: object
properties:
name:
type: string
pattern: ^[a-z\d_-]*$
maxLength: 256
description:
type: string
maxLength: 256
log_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
rule:
$ref: '#/components/schemas/LogMeasureRuleModelRequest'
required:
- log_storage_id
- metrics_storage_id
- rule
PaginatedNotificationRoutingList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/NotificationRouting'
NotificationRoutingOrderRequest:
type: object
properties:
notification_routing_uid:
type: string
format: uuid
order:
type: integer
minimum: 1
required:
- notification_routing_uid
- order
PatchedAlertRuleRequest:
type: object
properties:
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
name:
type: string
maxLength: 256
query:
type: string
minLength: 1
maxLength: 4096
format:
type: string
maxLength: 256
template:
type: string
maxLength: 256
enabled_warning:
type: boolean
enabled_critical:
type: boolean
threshold_warning:
type:
- string
- 'null'
minLength: 1
maxLength: 256
threshold_critical:
type:
- string
- 'null'
minLength: 1
maxLength: 256
threshold_duration_warning:
type: integer
format: int64
title: Threshold duration
threshold_duration_critical:
type: integer
format: int64
PatchedAlertProjectRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
MapFieldName:
enum:
- resource_labels
- labels
- resource_attributes
- attributes
- json_payload
title: MapFieldName
type: string
EnumMatcher:
properties:
type:
title: Type
type: string
enum:
- enum
field:
$ref: '#/components/schemas/FieldModel'
value:
items:
$ref: '#/components/schemas/ValueEnum'
title: Value
type: array
required:
- type
- field
- value
title: EnumMatcher
type: object
Operator1:
enum:
- eq
- ne
- gt
- lt
- gte
- lte
- multi-eq
title: Operator1
type: string
AlertProjectRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
FieldMatcher:
discriminator:
mapping:
and: '#/components/schemas/AndMatcher'
boolean: '#/components/schemas/BoolMatcher'
enum: '#/components/schemas/EnumMatcher'
map-key-exists: '#/components/schemas/MapKeyExistsMatcher'
map-key-value-matcher: '#/components/schemas/MapKeyValueMatcher'
map-value-number: '#/components/schemas/MapValueNumMatcher'
map-value-string: '#/components/schemas/MapValueStrMatcher'
number: '#/components/schemas/NumMatcher'
or: '#/components/schemas/OrMatcher'
string: '#/components/schemas/StrMatcher'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OrMatcher'
- $ref: '#/components/schemas/AndMatcher'
- $ref: '#/components/schemas/StrMatcher'
- $ref: '#/components/schemas/NumMatcher'
- $ref: '#/components/schemas/BoolMatcher'
- $ref: '#/components/schemas/EnumMatcher'
- $ref: '#/components/schemas/MapKeyExistsMatcher'
- $ref: '#/components/schemas/MapKeyValueMatcher'
- $ref: '#/components/schemas/MapValueStrMatcher'
- $ref: '#/components/schemas/MapValueNumMatcher'
title: FieldMatcher
MapKeyValueMatcher:
properties:
type:
title: Type
type: string
enum:
- map-key-value-matcher
field:
$ref: '#/components/schemas/MapFieldName'
key:
title: Key
type: string
value:
title: Value
type: string
required:
- type
- field
- key
- value
title: MapKeyValueMatcher
type: object
NotificationTarget:
type: object
properties:
uid:
type: string
format: uuid
readOnly: true
project_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
readOnly: true
service_type:
enum:
- SAKURA_SIMPLE_NOTICE
- SAKURA_EVENT_BUS
type: string
description: '* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification
* `SAKURA_EVENT_BUS` - Sakura cloud event bus'
x-spec-enum-id: 3b143ded19bdc92e
url:
type: string
maxLength: 1024
config:
type: object
readOnly: true
description:
type: string
maxLength: 100
required:
- config
- project_id
- service_type
- uid
BooleanFieldName:
enum:
- http_cache_lookup
- http_cache_hit
title: BooleanFieldName
type: string
ValueEnum:
enum:
- DEFAULT
- DEBUG
- INFO
- NOTICE
- WARNING
- ERROR
- CRITICAL
- ALERT
- EMERGENCY
title: ValueEnum
type: string
AlertProjectCreateRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
required:
- name
PatchedNotificationTargetRequest:
type: object
properties:
service_type:
enum:
- SAKURA_SIMPLE_NOTICE
- SAKURA_EVENT_BUS
type: string
description: '* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification
* `SAKURA_EVENT_BUS` - Sakura cloud event bus'
x-spec-enum-id: 3b143ded19bdc92e
url:
type: string
maxLength: 1024
description:
type: string
maxLength: 100
StringFieldName:
enum:
- log_name
- insert_id
- resource_type
- http_request_method
- http_request_url
- http_user_agent
- http_remote_ip
- http_server_ip
- http_referer
- http_protocol
- http_schema
- http_user
- source_loc_file
- source_line
- source_function
- text_payload
- json_payload
- sakuracloud_publisher
- sakuracloud_variant
- sakuracloud_account
- trace_id
- span_id
- parent_span_id
- service_name
- service_instance_id
- service_namespace
- service_version
- deployment_environment_name
- span_name
- span_status_code_text
title: StringFieldName
type: string
Operator3:
enum:
- eq
- ne
- gt
- lt
- gte
- lte
- multi-eq
- like
- ilike
title: Operator3
type: string
History:
type: object
properties:
uid:
type: string
format: uuid
readOnly: true
project_id:
type: integer
format: int64
readOnly: true
rule_uid:
type: string
readOnly: true
startsAt:
type: string
format: date-time
title: Starts_at
endsAt:
type:
- string
- 'null'
format: date-time
title: Ends_at
open:
type: boolean
labels:
type: string
maxLength: 4096
severity:
enum:
- warning
- critical
type: string
description: '* `warning` - Warning
* `critical` - Critical'
x-spec-enum-id: eb2a007069bad0df
query:
type: string
maxLength: 4096
threshold:
type: string
maxLength: 256
value:
type: number
format: double
required:
- labels
- open
- project_id
- rule_uid
- severity
- startsAt
- uid
NumMatcher:
properties:
type:
title: Type
type: string
enum:
- number
operator:
$ref: '#/components/schemas/Operator1'
field:
$ref: '#/components/schemas/NumberFieldName'
value:
title: Value
type: number
format: double
value_list:
description: use only multi-eq
items:
type: number
format: double
title: Value List
type: array
required:
- type
- operator
- field
- value
- value_list
title: NumMatcher
type: object
LogMeasureRuleV1:
properties:
matchers:
items:
$ref: '#/components/schemas/FieldMatcher'
title: Matchers
type: array
required:
- matchers
title: LogMeasureRuleV1
type: object
PatchedNotificationRoutingRequest:
type: object
properties:
notification_target_uid:
type: string
format: uuid
writeOnly: true
match_labels:
type: array
items:
$ref: '#/components/schemas/MatchLabelsItemRequest'
resend_interval_minutes:
type: integer
maximum: 720
minimum: 0
PatchedLogMeasureRuleRequest:
type: object
properties:
name:
type: string
pattern: ^[a-z\d_-]*$
maxLength: 256
description:
type: string
maxLength: 256
log_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
rule:
$ref: '#/components/schemas/LogMeasureRuleModelRequest'
BoolMatcher:
properties:
type:
title: Type
type: string
enum:
- boolean
operator:
$ref: '#/components/schemas/Operator2'
field:
$ref: '#/components/schemas/BooleanFieldName'
value:
title: Value
type: boolean
required:
- type
- operator
- field
- value
title: BoolMatcher
type: object
StrMatcher:
properties:
type:
title: Type
type: string
enum:
- string
operator:
$ref: '#/components/schemas/Operator'
field:
$ref: '#/components/schemas/StringFieldName'
value:
title: Value
type: string
value_list:
items:
type: string
title: Value List
type: array
required:
- type
- operator
- field
- value
- value_list
title: StrMatcher
type: object
LogMeasureRule:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
project_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
pattern: ^[a-z\d_-]*$
maxLength: 256
description:
type: string
maxLength: 256
log_storage:
allOf:
- $ref: '#/components/schemas/LogStorage'
readOnly: true
metrics_storage:
allOf:
- $ref: '#/components/schemas/MetricsStorage'
readOnly: true
rule:
$ref: '#/components/schemas/LogMeasureRuleModel'
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
required:
- created_at
- id
- log_storage
- metrics_storage
- project_id
- rule
- uid
- updated_at
MapValueStrMatcher:
properties:
type:
title: Type
type: string
enum:
- map-value-string
operator:
$ref: '#/components/schemas/Operator3'
field:
$ref: '#/components/schemas/MapFieldName'
key:
title: Key
type: string
value:
title: Value
type: string
value_list:
items:
type: string
title: Value List
type: array
required:
- type
- operator
- field
- key
- value
- value_list
title: MapValueStrMatcher
type: object
NotificationRouting:
type: object
properties:
uid:
type: string
format: uuid
readOnly: true
project_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
readOnly: true
notification_target:
allOf:
- $ref: '#/components/schemas/NotificationTarget'
readOnly: true
match_labels:
type: array
items:
$ref: '#/components/schemas/MatchLabelsItem'
resend_interval_minutes:
type: integer
maximum: 720
minimum: 0
order:
type: integer
readOnly: true
required:
- match_labels
- notification_target
- order
- project_id
- uid
PaginatedAlertRuleList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/AlertRule'
DashboardProject:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
required:
- account_id
- created_at
- icon
- id
- resource_id
- tags
DashboardProjectCreateRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
required:
- name
DashboardProjectRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
PaginatedDashboardProjectList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/DashboardProject'
PatchedDashboardProjectRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
WrappedDashboardProject:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
is_ok:
type: boolean
required:
- account_id
- created_at
- icon
- id
- is_ok
- resource_id
- tags
LogStorageMonthlyUsage:
type: object
properties:
year:
type: integer
readOnly: true
month:
type: integer
readOnly: true
ingested_bytes:
type: integer
readOnly: true
ingested_rows:
type: integer
readOnly: true
max_stored_bytes:
type: integer
readOnly: true
timestamp:
type: string
format: date-time
readOnly: true
required:
- ingested_bytes
- ingested_rows
- max_stored_bytes
- month
- timestamp
- year
LogStorageDailyUsage:
type: object
properties:
date:
type: string
format: date
readOnly: true
ingested_bytes:
type: integer
readOnly: true
ingested_rows:
type: integer
readOnly: true
stored_bytes:
type:
- integer
- 'null'
readOnly: true
timestamp:
type: string
format: date-time
readOnly: true
required:
- date
- ingested_bytes
- ingested_rows
- stored_bytes
- timestamp
TraceStorage:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
retention_period_days:
type: integer
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
endpoints:
type: object
properties:
ingester:
type: object
properties:
address:
type: string
insecure:
type: boolean
required:
- address
required:
- ingester
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type: integer
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
classification:
type: string
enum:
- shared
- dedicated
readOnly: true
kms_key_id:
type:
- integer
- 'null'
format: int64
readOnly: true
service_principal_id:
type:
- integer
- 'null'
format: int64
required:
- account_id
- classification
- created_at
- endpoints
- icon
- id
- kms_key_id
- resource_id
- retention_period_days
- tags
TraceStorageMonthlyUsageBody:
type: object
properties:
usages:
type: array
items:
$ref: '#/components/schemas/LogStorageMonthlyUsage'
required:
- usages
SetTraceStorageExpireDayRequest:
type: object
properties:
days:
type: integer
maximum: 730
minimum: 1
required:
- days
WrappedTraceStorage:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
retention_period_days:
type: integer
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
endpoints:
type: object
properties:
ingester:
type: object
properties:
address:
type: string
insecure:
type: boolean
required:
- address
required:
- ingester
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type: integer
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
classification:
type: string
enum:
- shared
- dedicated
readOnly: true
kms_key_id:
type:
- integer
- 'null'
format: int64
readOnly: true
service_principal_id:
type:
- integer
- 'null'
format: int64
is_ok:
type: boolean
required:
- account_id
- classification
- created_at
- endpoints
- icon
- id
- is_ok
- kms_key_id
- resource_id
- retention_period_days
- tags
PatchedTraceStorageRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
service_principal_id:
type:
- integer
- 'null'
format: int64
PaginatedTraceStorageAccessKeyList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/TraceStorageAccessKey'
WrappedTraceStorageAccessKey:
type: object
properties:
uid:
type: string
format: uuid
readOnly: true
secret:
type: string
readOnly: true
token:
type: string
description: Returns a token string for the access key.
readOnly: true
description:
type: string
maxLength: 256
is_ok:
type: boolean
required:
- is_ok
- secret
- token
- uid
TraceStorageDailyUsageBody:
type: object
properties:
usages:
type: array
items:
$ref: '#/components/schemas/LogStorageDailyUsage'
required:
- usages
TraceStorageCreateRequest:
type: object
properties:
classification:
enum:
- shared
- dedicated
type: string
description: '* `shared` - 共用
* `dedicated` - 専有'
x-spec-enum-id: 3896f704b7462b41
default: shared
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
kms_key_id:
type:
- integer
- 'null'
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
service_principal_id:
type:
- integer
- 'null'
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
required:
- name
TraceStorageAccessKey:
type: object
properties:
uid:
type: string
format: uuid
readOnly: true
secret:
type: string
readOnly: true
token:
type: string
description: Returns a token string for the access key.
readOnly: true
description:
type: string
maxLength: 256
required:
- secret
- token
- uid
TraceStorageRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
service_principal_id:
type:
- integer
- 'null'
format: int64
TraceStorageAccessKeyRequest:
type: object
properties:
description:
type: string
maxLength: 256
PaginatedTraceStorageList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/TraceStorage'
PatchedTraceStorageAccessKeyRequest:
type: object
properties:
description:
type: string
maxLength: 256
PatchedMetricsStorageAccessKeyRequest:
type: object
properties:
description:
type: string
maxLength: 256
MetricsStorageDailyUsageBody:
type: object
properties:
usages:
type: array
items:
$ref: '#/components/schemas/MetricsStorageDailyUsage'
required:
- usages
PatchedMetricsStorageRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
MetricsStorageAccessKeyRequest:
type: object
properties:
description:
type: string
maxLength: 256
WrappedMetricsStorageAccessKey:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
secret:
type: string
format: uuid
readOnly: true
token:
type: string
description: Returns a token string for the access key.
readOnly: true
description:
type: string
maxLength: 256
is_ok:
type: boolean
required:
- id
- is_ok
- secret
- token
- uid
MetricsStorageDailyUsage:
type: object
properties:
date:
type: string
format: date
readOnly: true
ingested_rows:
type: integer
readOnly: true
title: Ingested samples
timestamp:
type: string
format: date-time
readOnly: true
required:
- date
- ingested_rows
- timestamp
MetricsStorageMonthlyUsageBody:
type: object
properties:
usages:
type: array
items:
$ref: '#/components/schemas/MetricsStorageMonthlyUsage'
required:
- usages
MetricsStorageRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
MetricsStorageCreateRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
is_system:
type: boolean
required:
- is_system
- name
WrappedMetricsStorage:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
is_system:
type: boolean
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
endpoints:
type: object
properties:
address:
type: string
required:
- address
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
updated_at:
type: string
format: date-time
readOnly: true
title: Update datetime
usage:
type: object
properties:
metrics_routings:
type: integer
alert_rules:
type: integer
log_measure_rules:
type: integer
required:
- metrics_routings
- alert_rules
- log_measure_rules
readOnly: true
is_ok:
type: boolean
required:
- account_id
- created_at
- endpoints
- icon
- id
- is_ok
- is_system
- resource_id
- tags
- updated_at
- usage
MetricsStorageMonthlyUsage:
type: object
properties:
year:
type: integer
readOnly: true
month:
type: integer
readOnly: true
ingested_rows:
type: integer
readOnly: true
title: Ingested samples
timestamp:
type: string
format: date-time
readOnly: true
required:
- ingested_rows
- month
- timestamp
- year
PaginatedMetricsStorageList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/MetricsStorage'
MetricsStorageAccessKey:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
secret:
type: string
format: uuid
readOnly: true
token:
type: string
description: Returns a token string for the access key.
readOnly: true
description:
type: string
maxLength: 256
required:
- id
- secret
- token
- uid
PaginatedMetricsStorageAccessKeyList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/MetricsStorageAccessKey'
PaginatedMetricsRoutingList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/MetricsRouting'
PatchedMetricsRoutingRequest:
type: object
properties:
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher_code:
type: string
minLength: 1
writeOnly: true
variant:
type: string
minLength: 1
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
Publisher:
type: object
properties:
code:
type: string
maxLength: 256
description:
type: string
maxLength: 256
variants:
type: array
items:
$ref: '#/components/schemas/PublisherVariant'
readOnly: true
required:
- code
- variants
MetricsRouting:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher:
allOf:
- $ref: '#/components/schemas/Publisher'
readOnly: true
variant:
type: string
metrics_storage:
allOf:
- $ref: '#/components/schemas/MetricsStorage'
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Create datetime
updated_at:
type: string
format: date-time
readOnly: true
title: Update datetime
required:
- created_at
- id
- metrics_storage
- publisher
- uid
- updated_at
- variant
PublisherVariant:
type: object
properties:
name:
type: string
label:
type: string
storage:
enum:
- metrics
- logs
type: string
description: '* `metrics` - metrics
* `logs` - logs'
x-spec-enum-id: 629e061395ff654f
system:
enum:
- disallow
- required
type: string
description: '* `disallow` - disallow
* `required` - required'
x-spec-enum-id: 753020b5ff95d9fa
metrics_prefix:
type:
- string
- 'null'
required:
- label
- name
- storage
- system
WrappedMetricsRouting:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher:
allOf:
- $ref: '#/components/schemas/Publisher'
readOnly: true
variant:
type: string
metrics_storage:
allOf:
- $ref: '#/components/schemas/MetricsStorage'
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Create datetime
updated_at:
type: string
format: date-time
readOnly: true
title: Update datetime
is_ok:
type: boolean
required:
- created_at
- id
- is_ok
- metrics_storage
- publisher
- uid
- updated_at
- variant
MetricsRoutingRequest:
type: object
properties:
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher_code:
type: string
minLength: 1
writeOnly: true
variant:
type: string
minLength: 1
metrics_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
required:
- metrics_storage_id
- publisher_code
- variant
LogStorageAccessKey:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
secret:
type: string
format: uuid
readOnly: true
token:
type: string
description: Returns a token string for the access key.
readOnly: true
description:
type: string
maxLength: 256
required:
- id
- secret
- token
- uid
PaginatedLogStorageList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/LogStorage'
LogStorageCreateRequest:
type: object
properties:
classification:
enum:
- shared
- dedicated
type: string
description: '* `shared` - 共用
* `dedicated` - 専有'
x-spec-enum-id: 3896f704b7462b41
default: shared
is_system:
type: boolean
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
kms_key_id:
type:
- integer
- 'null'
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
service_principal_id:
type:
- integer
- 'null'
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
required:
- is_system
- name
PatchedLogStorageRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
service_principal_id:
type:
- integer
- 'null'
format: int64
WrappedLogStorage:
type: object
properties:
id:
type: integer
format: int64
title: Cloud resource id
readOnly: true
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
tags:
type: array
items:
type: string
readOnly: true
icon:
type:
- object
- 'null'
properties:
id:
type: string
readOnly: true
expire_day:
type: integer
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Register datetime
endpoints:
type: object
properties:
ingester:
type: object
properties:
address:
type: string
insecure:
type: boolean
required:
- address
required:
- ingester
readOnly: true
account_id:
type: string
readOnly: true
title: Cloud account id
resource_id:
type:
- integer
- 'null'
readOnly: true
title: Cloud resource id
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
is_system:
type: boolean
readOnly: true
classification:
type: string
enum:
- shared
- dedicated
readOnly: true
kms_key_id:
type:
- integer
- 'null'
readOnly: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
service_principal_id:
type:
- integer
- 'null'
format: int64
usage:
type: object
properties:
log_routings:
type: integer
log_measure_rules:
type: integer
required:
- log_routings
- log_measure_rules
readOnly: true
is_ok:
type: boolean
required:
- account_id
- classification
- created_at
- endpoints
- expire_day
- icon
- id
- is_ok
- is_system
- kms_key_id
- resource_id
- tags
- usage
LogStorageAccessKeyRequest:
type: object
properties:
description:
type: string
maxLength: 256
WrappedLogStorageAccessKey:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
secret:
type: string
format: uuid
readOnly: true
token:
type: string
description: Returns a token string for the access key.
readOnly: true
description:
type: string
maxLength: 256
is_ok:
type: boolean
required:
- id
- is_ok
- secret
- token
- uid
LogStorageMonthlyUsageBody:
type: object
properties:
usages:
type: array
items:
$ref: '#/components/schemas/LogStorageMonthlyUsage'
required:
- usages
LogStorageRequest:
type: object
properties:
name:
type: string
maxLength: 64
description:
type: string
maxLength: 512
service_principal_id:
type:
- integer
- 'null'
format: int64
PatchedLogStorageAccessKeyRequest:
type: object
properties:
description:
type: string
maxLength: 256
LogStorageDailyUsageBody:
type: object
properties:
usages:
type: array
items:
$ref: '#/components/schemas/LogStorageDailyUsage'
required:
- usages
SetLogStorageExpireDayRequest:
type: object
properties:
days:
type: integer
maximum: 730
minimum: 1
required:
- days
PaginatedLogStorageAccessKeyList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/LogStorageAccessKey'
WrappedLogRouting:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher:
allOf:
- $ref: '#/components/schemas/Publisher'
readOnly: true
variant:
type: string
log_storage:
allOf:
- $ref: '#/components/schemas/LogStorage'
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Create datetime
updated_at:
type: string
format: date-time
readOnly: true
title: Update datetime
is_ok:
type: boolean
required:
- created_at
- id
- is_ok
- log_storage
- publisher
- uid
- updated_at
- variant
PaginatedLogRoutingList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/LogRouting'
LogRoutingRequest:
type: object
properties:
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher_code:
type: string
minLength: 1
writeOnly: true
variant:
type: string
minLength: 1
log_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
required:
- log_storage_id
- publisher_code
- variant
PatchedLogRoutingRequest:
type: object
properties:
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher_code:
type: string
minLength: 1
writeOnly: true
variant:
type: string
minLength: 1
log_storage_id:
type:
- integer
- 'null'
format: int64
title: Cloud resource id
writeOnly: true
LogRouting:
type: object
properties:
id:
type: integer
readOnly: true
deprecated: true
format: int64
minimum: 0
maximum: 999999999999
example: 110000000000
uid:
type: string
format: uuid
readOnly: true
resource_id:
type:
- integer
- 'null'
format: int64
description: 対象リソースのID
publisher:
allOf:
- $ref: '#/components/schemas/Publisher'
readOnly: true
variant:
type: string
log_storage:
allOf:
- $ref: '#/components/schemas/LogStorage'
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
title: Create datetime
updated_at:
type: string
format: date-time
readOnly: true
title: Update datetime
required:
- created_at
- id
- log_storage
- publisher
- uid
- updated_at
- variant
ProvisioningExist:
type: object
properties:
system_exist:
type: boolean
user_exist:
type: boolean
required:
- system_exist
- user_exist
Provisioning:
type: object
properties:
logs:
$ref: '#/components/schemas/ProvisioningExist'
metrics:
$ref: '#/components/schemas/ProvisioningExist'
required:
- logs
- metrics
ResourceItemLimits:
type: object
properties:
max_user_count:
type: integer
description: Max number of user shared resources.
max_user_dedicated_count:
type: integer
description: Max number of user dedicated resources (if supported).
required:
- max_user_count
ProvisioningExistRequest:
type: object
properties:
system_exist:
type: boolean
user_exist:
type: boolean
required:
- system_exist
- user_exist
ProvisioningCreateRequest:
type: object
properties:
logs:
$ref: '#/components/schemas/ProvisioningExistRequest'
metrics:
$ref: '#/components/schemas/ProvisioningExistRequest'
ResourcesLimits:
type: object
properties:
logs:
$ref: '#/components/schemas/ResourceItemLimits'
metrics:
$ref: '#/components/schemas/ResourceItemLimits'
traces:
$ref: '#/components/schemas/ResourceItemLimits'
alerts:
$ref: '#/components/schemas/ResourceItemLimits'
dashboards:
$ref: '#/components/schemas/ResourceItemLimits'
required:
- alerts
- dashboards
- logs
- metrics
- traces
WrappedPublisher:
type: object
properties:
code:
type: string
maxLength: 256
description:
type: string
maxLength: 256
variants:
type: array
items:
$ref: '#/components/schemas/PublisherVariant'
readOnly: true
is_ok:
type: boolean
required:
- code
- is_ok
- variants
PaginatedPublisherList:
type: object
required:
- count
- from
- total
- results
properties:
count:
type: integer
format: int64
example: 123
from:
type: integer
format: int64
example: 0
total:
type: integer
format: int64
example: 123
is_ok:
type: boolean
example: true
results:
type: array
items:
$ref: '#/components/schemas/Publisher'
AddressResponse:
type: object
required:
- Address
properties:
Address:
$ref: '#/components/schemas/ReadAddress'
description: アドレス
description: 成功時のレスポンス
AddressListResponse:
type: object
required:
- Total
- From
- Count
- Addresses
properties:
Total:
type: integer
format: int32
description: 対象リソースの総件数
From:
type: integer
format: int32
description: 現在のページ番号
Count:
type: integer
format: int32
description: 現在のページの件数
Addresses:
type: array
items:
$ref: '#/components/schemas/ReadAddress'
description: アドレス一覧
description: 成功時のレスポンス
SakuraResourceNameRef:
type: object
required:
- SRN
properties:
SRN:
type: string
description: さくらのリソース名 (SRN)
ApiError:
type: object
properties:
serial:
type: string
error_code:
type: string
error_msg:
type: string
description: 失敗時のレスポンス
examples:
- serial: 4f464bf7db102d5e8e2092876506bc77
error_code: forbidden
error_msg: 要求された操作は許可されていません。権限エラー。
ReadAddress:
type: object
required:
- SRN
- AddressType
- IPVersion
- IPAddress
- Subnet
properties:
SRN:
type: string
description: さくらのリソース名 (SRN)
AddressType:
type: string
description: アドレス種別; `EPHEMERAL_ADDRESS` 固定
IPVersion:
type: string
description: アドレスバージョン; `IPv4` 固定
IPAddress:
type: string
description: IPアドレス
Subnet:
$ref: '#/components/schemas/SakuraResourceNameRef'
description: アドレスが属するサブネット
CreatedInterfaceConnectionResponse:
type: object
required:
- InterfaceConnection
properties:
InterfaceConnection:
$ref: '#/components/schemas/ReadInterfaceConnection'
description: インターフェースコネクション
description: 成功時のレスポンス
CreateInterfaceConnection:
type: object
required:
- Interface
- Subnet
properties:
EphemeralIPv4Address:
type: string
description: IPv4アドレス
Interface:
$ref: '#/components/schemas/SakuraResourceNameRef'
description: サーバーNIC (インターフェース)
Subnet:
$ref: '#/components/schemas/SakuraResourceNameRef'
description: サブネット
ReadInterfaceConnection:
type: object
required:
- SRN
properties:
SRN:
type: string
description: さくらのリソース名 (SRN)
EphemeralIPv4Address:
type: string
description: IPv4アドレス
SubnetGroupResponse:
type: object
required:
- SubnetGroup
properties:
SubnetGroup:
$ref: '#/components/schemas/ReadSubnetGroup'
description: サブネットグループ
description: 成功時のレスポンス
Region:
type: object
required:
- Code
properties:
Code:
type: string
description: リージョンコード ("is1")
ReadSubnetGroup:
type: object
required:
- SRN
- Name
- Description
- IPv4AddressRangeCIDR
- Region
properties:
SRN:
type: string
description: さくらのリソース名 (SRN)
Name:
type: string
description: 名前
Description:
type: string
description: 説明
IPv4AddressRangeCIDR:
type: string
description: 'IPv4アドレス範囲 (CIDR形式)
[マニュアル](https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html)内「仕様」に記載の条件を満たすIPアドレス範囲をCIDR形式で表現します。'
Region:
$ref: '#/components/schemas/Region'
description: リージョン
CreatedSubnetGroupResponse:
type: object
required:
- SubnetGroup
properties:
SubnetGroup:
$ref: '#/components/schemas/ReadSubnetGroup'
description: サブネットグループ
description: 成功時のレスポンス
SubnetGroupListResponse:
type: object
required:
- Total
- From
- Count
- SubnetGroups
properties:
Total:
type: integer
format: int32
description: 対象リソースの総件数
From:
type: integer
format: int32
description: 現在のページ番号
Count:
type: integer
format: int32
description: 現在のページの件数
SubnetGroups:
type: array
items:
$ref: '#/components/schemas/ReadSubnetGroup'
description: サブネットグループ一覧
description: 成功時のレスポンス
UpdateSubnetGroup:
type: object
required:
- Name
- Description
properties:
Name:
type: string
description: 名前
Description:
type: string
description: 説明
CreateSubnetGroup:
type: object
required:
- Name
- Description
- IPv4AddressRangeCIDR
- Region
properties:
Name:
type: string
description: 名前
Description:
type: string
description: 説明
IPv4AddressRangeCIDR:
type: string
description: 'IPv4アドレス範囲 (CIDR形式)
[マニュアル](https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html)内「仕様」に記載の条件を満たすIPアドレス範囲をCIDR形式で表現します。'
Region:
$ref: '#/components/schemas/Region'
description: リージョン
ReadSubnet:
type: object
required:
- SRN
- Name
- Description
- IPv4AddressRangeCIDR
- Zone
- SubnetGroup
properties:
SRN:
type: string
description: さくらのリソース名 (SRN)
Name:
type: string
description: 名前
Description:
type: string
description: 説明
IPv4AddressRangeCIDR:
type: string
description: 'IPv4アドレス範囲 (CIDR形式)
[マニュアル](https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html)内「仕様」に記載の条件を満たすIPアドレス範囲をCIDR形式で表現します。
IPv4アドレス範囲は、親サブネットグループのIPv4アドレス範囲に含まれ、かつ、同一親サブネットグループ下の他サブネットと重複しない範囲である必要があります。'
Zone:
$ref: '#/components/schemas/Zone'
description: ゾーン
SubnetGroup:
$ref: '#/components/schemas/SakuraResourceNameRef'
description: 親サブネットグループ
SubnetListResponse:
type: object
required:
- Total
- From
- Count
- Subnets
properties:
Total:
type: integer
format: int32
description: 対象リソースの総件数
From:
type: integer
format: int32
description: 現在のページ番号
Count:
type: integer
format: int32
description: 現在のページの件数
Subnets:
type: array
items:
$ref: '#/components/schemas/ReadSubnet'
description: サブネット一覧
description: 成功時のレスポンス
UpdateSubnet:
type: object
required:
- Name
- Description
properties:
Name:
type: string
description: 名前
Description:
type: string
description: 説明
CreateSubnet:
type: object
required:
- Name
- Description
- IPv4AddressRangeCIDR
- Zone
- SubnetGroup
properties:
Name:
type: string
description: 名前
Description:
type: string
description: 説明
IPv4AddressRangeCIDR:
type: string
description: 'IPv4アドレス範囲 (CIDR形式)
[マニュアル](https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html)内「仕様」に記載の条件を満たすIPアドレス範囲をCIDR形式で表現します。
IPv4アドレス範囲は、親サブネットグループのIPv4アドレス範囲に含まれ、かつ、同一親サブネットグループ下の他サブネットと重複しない範囲である必要があります。'
Zone:
$ref: '#/components/schemas/Zone'
description: ゾーン
SubnetGroup:
$ref: '#/components/schemas/SakuraResourceNameRef'
description: 親サブネットグループ
Zone:
type: object
required:
- Code
properties:
Code:
type: string
description: ゾーンコード ("is1c")
CreatedSubnetResponse:
type: object
required:
- Subnet
properties:
Subnet:
$ref: '#/components/schemas/ReadSubnet'
description: サブネット
description: 成功時のレスポンス
SubnetResponse:
type: object
required:
- Subnet
properties:
Subnet:
$ref: '#/components/schemas/ReadSubnet'
description: サブネット
description: 成功時のレスポンス
NosqlBackup:
type: object
required:
- backupId
- backupDestination
- backupAt
- size
properties:
backupId:
type: string
format: uuid
description: バックアップID
example: 123e4567-e89b-12d3-a456-426614174000
backupDestination:
type: string
description: バックアップ先
example: nfs://192.168.100.250/export
backupAt:
type: string
description: バックアップ日時
format: date-time
example: '2024-11-18T16:03:48.844+09:00'
restoreAt:
type: string
description: バックアップ復元日時
format: date-time
example: '2024-11-18T16:03:51.223+09:00'
size:
type: integer
description: バックアップサイズ
format: int64
example: 2
deleteStatus:
type: string
description: バックアップ削除ステータス(0:未削除, 1:削除中, 2:削除完了, 9:削除失敗)
example: '2'
restoreStatus:
type: string
description: バックアップ復元ステータス(0:未復元, 1:復元中, 2:復元完了, 9:復元失敗)
example: '2'
NosqlBackupResponse:
type: object
properties:
nosql:
type: object
properties:
backups:
type: array
description: バックアップデータリスト
items:
$ref: '#/components/schemas/NosqlBackup'
is_ok:
$ref: '#/components/schemas/is_ok'
is_ok:
type: boolean
description: 成功のレスポンス(true:成功)
example: true
ConflictErrorResponse:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 409 Conflict
error_code:
type: string
description: エラーコード
example: limit_count_in_zone
error_msg:
type: string
description: エラーメッセージ
example: 要求を受け付けできません。
NosqlOkResponse:
type: object
properties:
nosql:
type: object
properties:
is_ok:
$ref: '#/components/schemas/is_ok'
is_ok:
$ref: '#/components/schemas/is_ok'
NosqlUpdateVersionResponse:
type: object
properties:
nosql:
$ref: '#/components/schemas/NosqlVersion'
is_ok:
$ref: '#/components/schemas/is_ok'
NosqlVersionsResponse:
type: object
properties:
nosql:
type: object
required:
- DatabaseVersion
- UpgradableVersions
properties:
DatabaseVersion:
type: string
description: 現在のNoSQLのバージョン
example: 4.1.7
UpgradableVersions:
type: array
description: 更新可能なバージョンのリスト
items:
type: object
required:
- version
properties:
version:
type: string
description: 更新可能なバージョン
example: 4.1.9
is_ok:
type: boolean
description: 成功のレスポンス
example: true
NosqlVersion:
type: object
properties:
version:
type: string
description: NoSQLの更新可能なバージョン
pattern: ^\d+\.\d+\.\d+$
example: 4.1.9
NosqlUpdateVersionRequest:
type: object
required:
- nosql
properties:
nosql:
$ref: '#/components/schemas/NosqlVersion'
UpdateNosqlParametersRequest:
type: object
properties:
nosql:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/NosqlParameterSetting'
required:
- nosql
NosqlParameter:
type: object
required:
- settingItemId
- settingItem
- description
properties:
settingItemId:
type: string
description: 設定項目ID
example: 123e4567-e89b-12d3-a456-426614174000
settingItem:
type: string
description: 設定項目名
example: settingItem1
defaultValue:
type: string
description: デフォルト値
example: defaultValue1
description:
type: string
description: 説明
example: 説明1
parameterOptions:
type: array
example:
- option1
- option2
description: パラメータオプション
items:
type: string
settingValue:
type: string
description: 設定値
example: settingValue1
NosqlParameterSetting:
type: object
properties:
settingItemId:
type: string
description: 設定項目ID
example: 123e4567-e89b-12d3-a456-426614174000
settingValue:
type: string
description: 設定値
example: settingValue1
required:
- settingItemId
- settingValue
NosqlParametersResponse:
type: object
properties:
nosql:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/NosqlParameter'
is_ok:
$ref: '#/components/schemas/is_ok'
UpdateNosqlParametersResponse:
type: object
properties:
nosql:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/NosqlParameterSetting'
is_ok:
$ref: '#/components/schemas/is_ok'
NosqlRepairResponse:
type: object
properties:
is_ok:
type: boolean
description: 成功のレスポンス(true:成功)
example: true
allOf:
- $ref: '#/components/schemas/NosqlRepairRequest'
NosqlRepairRequest:
type: object
properties:
nosql:
type: object
properties:
repairType:
type: string
description: 'リペアタイプ
| 値 | 説明 | 実行コマンド |
|-------------|-----------|-----------------------------|
| Incremental | 増分リペア | nodetool repair -pr |
| Full | 完全リペア | nodetool repair --full -pr |
'
enum:
- Incremental
- Full
example: Incremental
Success:
oneOf:
- type: boolean
example: true
- type: string
example: Accepted
NodeHealth:
type: object
allOf:
- $ref: '#/components/schemas/SuccessResponse'
- type: object
properties:
Nosql:
type: object
properties:
Status:
type: string
description: 'NoSQLの状態
| 値 | 説明 |
|-----------|--------|
| healthy | 起動(すべてのノードが起動している) |
| healthy-partial | 部分起動(1台のノードが停止している) |
| unhealthy | 停止(2台以上のノードが停止している) |
※40GBプランではノードが1台のため、部分起動(`healthy-partial`)は発生しません。
'
enum:
- healthy
- healthy-partial
- unhealthy
example: healthy
SuccessResponse:
type: object
properties:
Success:
$ref: '#/components/schemas/Success'
is_ok:
$ref: '#/components/schemas/is_ok'
NosqlPower:
type: object
properties:
Instance:
type: object
properties:
Status:
type: string
description: 'NoSQLノードの起動状態
1ノードでも起動している場合、up
全ノード停止している場合、down
'
example: up
is_ok:
type: boolean
description: 成功のレスポンス(true:成功)
example: true
model.Cluster:
type: object
properties:
api_zone:
description: API Servers Zones
type: array
items:
type: string
example:
- is1b
control_panel_url:
description: URL of Control Panel
type: string
example: secure.sakura.ad.jp/objectstorage/isk01
display_name_en_us:
description: Display Name (en-us)
type: string
example: 'Ishikari Cluster #1'
display_name_ja:
description: Display Name (ja)
type: string
example: 石狩第1サイト
display_name:
description: Display Name (Depending on Accept-Language)
type: string
example: 石狩第1サイト
display_order:
description: Display Order (Can be ignored)
type: integer
example: 1
endpoint_base:
description: Endpoint Base of Cluster
type: string
example: isk01.objectstorage.sakurastorage.jp
id:
type: string
example: isk01
region:
type: string
example: jp-north-1
s3_endpoint:
description: URL of S3-compat API
type: string
example: s3.isk01.objectstorage.sakurastorage.jp
s3_endpoint_for_control_panel:
description: URL of S3-compat API (w/ resigning)
type: string
example: s3.cp.isk01.objectstorage.sakurastorage.jp
storage_zone:
description: Storage Servers Zones
type: array
items:
type: string
example:
- is1a
- is1b
plan_family:
type: string
description: Pricing/behavior family of the cluster.
enum:
- standard
- archive
example: standard
ErrorMessage:
description: 'エラー発生時のメッセージ内容。
このメッセージはエラーを発生させたアプリケーションのメッセージをそのまま含む場合がある。
'
type: string
handler.ReadClusterResponse:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/ClusterResponseBody'
Error401:
type: object
properties:
error:
description: error 401
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 401
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: Authentication failed.
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
ErrorsDomain:
description: 'どのサービスで発生したエラーかを判別する。
マイクロサービス名に加えてクラスター名を含む文字列が入ることを想定している。
'
type: string
Error404:
type: object
properties:
error:
description: error 404
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 404
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: XXXX does not exist.
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
Errors:
description: '認証に関するエラーについて詳細なエラー内容を表示する。
'
type: array
items:
type: object
properties:
domain:
allOf:
- $ref: '#/components/schemas/ErrorsDomain'
example: '{federaton,cluster}-api-objectstorage.sacloud'
location:
allOf:
- $ref: '#/components/schemas/ErrorsLocation'
example: String
location_type:
allOf:
- $ref: '#/components/schemas/ErrorsLocationType'
example: String
message:
allOf:
- $ref: '#/components/schemas/ErrorsMessage'
example: XXXX failed.
reason:
allOf:
- $ref: '#/components/schemas/ErrorsReason'
example: XXXX is wrong. Should set valid parameters.
ErrorsLocation:
description: 'エラー発生箇所。
どのリソースなのか(どのリソースを操作した時に発生したものなのか)、
どのパラメータなのかといった情報。
'
type: string
handler.ListClustersResponse:
type: object
required:
- data
properties:
data:
description: If use a pointer type, break output
type: array
items:
$ref: '#/components/schemas/ClusterResponseBody'
ErrorTraceId:
description: 'トレースID。
エラー発生時のログ特定などに利用する。
'
type: string
ErrorsMessage:
description: 'エラー発生時のメッセージ内容。
このメッセージはエラーを発生させたアプリケーションのメッセージをそのまま含む場合がある。
'
type: string
ClusterResponseBody:
allOf:
- $ref: '#/components/schemas/model.Cluster'
- type: object
required:
- api_zone
- control_panel_url
- display_name_en_us
- display_name_ja
- display_name
- display_order
- endpoint_base
- id
- region
- s3_endpoint
- s3_endpoint_for_control_panel
- storage_zone
- plan_family
ErrorCode:
description: 'エラーコード。
'
type: integer
format: int32
ErrorsLocationType:
description: 'エラーの発生箇所の種類。
HTTPヘッダなのかHTTPパラメータなのか、
S3バケットなのかといったlocationの種別情報。
'
type: string
ErrorsReason:
description: 'なぜそのエラーが発生したかがわかる情報。
エラーメッセージの原因やエラー解決のためのヒントも含む場合がある。
'
type: string
Error409:
type: object
properties:
error:
description: error 409
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 409
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: XXXX already created.
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
Error403:
type: object
properties:
error:
description: error 403
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 403
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: XXXX creation denied.
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
accountKey:
description: Root user access key
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- id
- created_at
- secret
properties:
id:
allOf:
- $ref: '#/components/schemas/AccessKeyID'
secret:
allOf:
- $ref: '#/components/schemas/SecretAccessKey'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
SecretAccessKey:
description: Secret Access key
type: string
pattern: ^[\w\d\/+=]{1,40}$
example: /NOTICE==EXISTS+ONLY+WHEN+JUST+CREATED/
Code:
description: Code
type: string
pattern: ^[\w@]+$
example: abc01234@foo@isk01
ErrorDefault:
type: object
properties:
error:
description: error 500
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 500
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: unknown error occurred.
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
ResourceID:
description: Resource ID
type: string
pattern: ^\d{1,12}$
example: '123456789012'
readAccountKey:
description: Root user access key
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- id
- created_at
properties:
id:
allOf:
- $ref: '#/components/schemas/AccessKeyID'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
CreatedAt:
description: Created at
type: string
format: date-time
example: '2020-01-11T01:11:23.123456+09:00'
Account:
description: Account info
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- resource_id
- code
- created_at
properties:
resource_id:
allOf:
- $ref: '#/components/schemas/ResourceID'
code:
allOf:
- $ref: '#/components/schemas/Code'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
accountKeys:
description: Root user access keys
type: object
required:
- data
properties:
data:
description: data type
type: array
items:
type: object
required:
- id
- created_at
properties:
id:
allOf:
- $ref: '#/components/schemas/AccessKeyID'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
AccessKeyID:
description: Access key ID
type: string
pattern: ^[\w\d\/]{1,40}$
example: abcdefABCDEF0123456789
Status:
description: Status
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- accept_new
- message
- started_at
- status_code
properties:
accept_new:
type: boolean
example: true
message:
type: string
example: some extra info
started_at:
type: string
format: date-time
example: '2020-01-11T01:11:23.123456+09:00'
status_code:
type: object
required:
- id
- status
properties:
id:
type: integer
example: 1
status:
type: string
example: available
PlanWithContract:
type: object
required:
- plan
- contract
properties:
plan:
$ref: '#/components/schemas/PlanSummary'
contract:
$ref: '#/components/schemas/ContractSummary'
handler.CreateBucketResponse:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/BucketResponseBody'
model.PlanType:
type: string
description: Plan type enum
enum:
- standard
- archive
example: archive
handler.ReadBucketEncryptionResponse:
type: object
required:
- kms_key_id
- configured_at
properties:
kms_key_id:
allOf:
- $ref: '#/components/schemas/ResourceID'
configured_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
BucketResponseBody:
allOf:
- $ref: '#/components/schemas/model.Bucket'
- type: object
required:
- cluster_id
- name
- plan
properties:
plan:
$ref: '#/components/schemas/BucketPlanResponseBody'
handler.CreateBucketReplicationResponse:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/model.Replication'
example:
data:
source_bucket:
name: my-bucket
cluster_id: isk01
plan:
type: ''
service_class_path: ''
dest_bucket:
name: my-bucket-replica
cluster_id: tky01
plan:
type: ''
service_class_path: ''
config_status: created
created_at: '2024-01-01T12:00:00+09:00'
BucketListResponseBody:
type: object
required:
- name
- resource_id
properties:
name:
allOf:
- $ref: '#/components/schemas/BucketName'
resource_id:
allOf:
- $ref: '#/components/schemas/ResourceID'
plan:
type: object
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
BucketName:
description: バケット名
type: string
minLength: 3
maxLength: 64
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
example: sample1-bucket
BucketPenalty:
description: Bucket penalty
type: object
required:
- data
properties:
data:
type: object
required:
- num_objects_per_bucket
- amount_gib_per_bucket
properties:
num_objects_per_bucket:
type: object
required:
- val
- quota
- is_applied
properties:
val:
type: integer
example: 10002495
quota:
type: integer
example: 10000000
is_applied:
type: boolean
amount_gib_per_bucket:
type: object
required:
- val
- quota
- is_applied
properties:
val:
type: number
format: float
example: 614.25366
quota:
type: number
format: float
example: 10240
is_applied:
type: boolean
example: true
PlanChangeReqBody:
type: object
required:
- previous_contract
- new_plan
properties:
previous_contract:
type: object
required:
- resource_id
properties:
resource_id:
description: 'Current contract resource ID. This is for validation to avoid recontracting from an unexpected state.
'
$ref: '#/components/schemas/ResourceID'
new_plan:
type: object
required:
- type
- service_class_path
description: New plan to recontract to.
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
PlanSummary:
type: object
required:
- type
- service_class_path
- cluster_id
- capacity_gib
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
cluster_id:
type: string
example: isk01
description: 'Cluster ID to which this plan applies. In the response of /buckets/{name}/plan, this always matches bucket.cluster_id (redundant, read-only).
'
capacity_gib:
type:
- integer
- 'null'
description: Only archive is enabled (capacity resolved from the service class path)
example: 2000
BucketUsage:
description: Bucket usage
type: object
required:
- data
properties:
data:
type: object
required:
- num_objects_per_bucket
- amount_gib_per_bucket
properties:
num_objects_per_bucket:
type: integer
example: 10000000
amount_gib_per_bucket:
type: number
format: float
example: 10240
model.Bucket:
type: object
properties:
cluster_id:
type: string
name:
type: string
plan:
type: object
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
example:
cluster_id: isk01
name: my-bucket
plan:
type: standard
service_class_path: objectstorage/isk01/bucket
Error400:
type: object
properties:
error:
description: error 400
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 400
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: Invalid parameters.
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
model.Replication:
type: object
required:
- source_bucket
- dest_bucket
- config_status
- created_at
properties:
source_bucket:
type: object
required:
- name
- cluster_id
- plan
description: Source bucket info
properties:
name:
type: string
cluster_id:
type: string
plan:
type: object
required:
- type
- service_class_path
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
example:
name: my-bucket
cluster_id: isk01
plan:
type: standard
service_class_path: objectstorage/isk01/bucket
dest_bucket:
type: object
required:
- name
- cluster_id
- plan
description: Destination bucket info
properties:
name:
type: string
cluster_id:
type: string
plan:
type: object
required:
- type
- service_class_path
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
example:
name: my-bucket-replica
cluster_id: tky01
plan:
type: standard
service_class_path: objectstorage/isk01/bucket
config_status:
type: string
enum:
- creating
- created
description: creating=federation→cluster applying / created=cluster applied
created_at:
type: string
format: date-time
Error405:
type: object
properties:
error:
description: error 405
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
example: 405
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
example: Method Not Allowed
trace_id:
allOf:
- $ref: '#/components/schemas/ErrorTraceId'
example: 0f36837633984f3fc8871f515e8efa24
errors:
allOf:
- $ref: '#/components/schemas/Errors'
ServiceClassPath:
type: string
description: Plan identifier (service class path). Attributes such as capacity are resolved by the server based on this value.
example: objectstorage/arc02/bucket/2t
handler.CreateBucketRequestBody:
type: object
required:
- cluster_id
properties:
cluster_id:
type: string
plan:
type:
- object
- 'null'
description: If not specified, the bucket will be created as "standard".
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
handler.ListBucketReplicableTargetsResponse:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/BucketListResponseBody'
PlanChangeResBody:
type: object
properties:
previous_contract:
$ref: '#/components/schemas/ContractSummary'
new_contract:
$ref: '#/components/schemas/ContractSummary'
plan:
$ref: '#/components/schemas/PlanSummary'
ContractSummary:
type: object
required:
- resource_id
- status
- created_at
- deleted_at
properties:
resource_id:
type: string
example: '113200009999'
status:
type: string
enum:
- active
- terminated
created_at:
type: string
format: date-time
deleted_at:
type:
- string
- 'null'
format: date-time
handler.UpdateBucketEncryptionResponse:
type: object
required:
- kms_key_id
- configured_at
properties:
kms_key_id:
allOf:
- $ref: '#/components/schemas/ResourceID'
configured_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
handler.UpdateBucketEncryptionRequestBody:
type: object
required:
- kms_key_id
properties:
kms_key_id:
allOf:
- $ref: '#/components/schemas/ResourceID'
handler.ReadBucketReplicationResponse:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/model.Replication'
example:
data:
source_bucket:
name: my-bucket
cluster_id: isk01
plan:
type: ''
service_class_path: ''
dest_bucket:
name: my-bucket-replica
cluster_id: tky01
plan:
type: ''
service_class_path: ''
config_status: created
created_at: '2024-01-01T12:00:00+09:00'
handler.ListBucketsResponse:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/BucketListResponseBody'
BucketPlanResponseBody:
type: object
required:
- type
- service_class_path
properties:
type:
$ref: '#/components/schemas/model.PlanType'
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
BucketQuota:
description: Bucket quota
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- num_objects_per_bucket
- amount_gib_per_bucket
properties:
num_objects_per_bucket:
type: integer
example: 10000000
amount_gib_per_bucket:
type: number
format: float
example: 10240
Permissions:
description: Permission
type: object
required:
- data
properties:
data:
description: data type
type: array
items:
type: object
required:
- id
- display_name
- bucket_controls
- created_at
properties:
id:
allOf:
- $ref: '#/components/schemas/PermissionID'
display_name:
allOf:
- $ref: '#/components/schemas/DisplayName'
bucket_controls:
allOf:
- $ref: '#/components/schemas/BucketControls'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
PermissionKeyID:
description: Permission key ID
type: string
pattern: ^[\w\d\/]{1,40}$
example: abcdefABCDEF0123456789
PermissionID:
description: Permission ID
type: integer
format: int64
example: 123
handler.ReadPermissionKeyResponse:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/PermissionKeyReadResponseBody'
CanRead:
description: The flag to read bucket contents
type: boolean
example: true
handler.ListPermissionKeysResponse:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/PermissionKeyReadResponseBody'
PermissionBucketControlsBody:
description: Request body for bucket controls for Permission
type: object
required:
- display_name
- bucket_controls
properties:
display_name:
allOf:
- $ref: '#/components/schemas/DisplayName'
bucket_controls:
allOf:
- $ref: '#/components/schemas/BucketControlsBody'
DisplayName:
description: Display name
type: string
pattern: ^.+$
example: abc012345-
CanWrite:
description: The flag to write bucket contents
type: boolean
example: true
BucketControlsBody:
description: Request body for bucket controls for Permission
type: array
items:
type: object
required:
- bucket_name
- can_read
- can_write
properties:
bucket_name:
$ref: '#/components/schemas/BucketName'
can_read:
$ref: '#/components/schemas/CanRead'
can_write:
$ref: '#/components/schemas/CanWrite'
Permission:
description: Permission
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- id
- display_name
- bucket_controls
- created_at
properties:
id:
allOf:
- $ref: '#/components/schemas/PermissionID'
display_name:
allOf:
- $ref: '#/components/schemas/DisplayName'
bucket_controls:
allOf:
- $ref: '#/components/schemas/BucketControls'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
BucketControls:
description: Bucket controls
type: array
items:
type: object
required:
- bucket_name
- can_read
- can_write
- created_at
properties:
bucket_name:
$ref: '#/components/schemas/BucketName'
can_read:
$ref: '#/components/schemas/CanRead'
can_write:
$ref: '#/components/schemas/CanWrite'
created_at:
$ref: '#/components/schemas/CreatedAt'
handler.CreatePermissionKeyResponse:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/PermissionKeyCreateResponseBody'
PermissionKey:
description: Permission Key
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/PermissionKeyID'
secret:
allOf:
- $ref: '#/components/schemas/PermissionKeySecret'
created_at:
allOf:
- $ref: '#/components/schemas/CreatedAt'
PermissionKeyCreateResponseBody:
allOf:
- $ref: '#/components/schemas/PermissionKey'
- type: object
required:
- id
- secret
- created_at
PermissionKeyReadResponseBody:
type: object
required:
- id
- created_at
properties:
id:
$ref: '#/components/schemas/PermissionKeyID'
created_at:
$ref: '#/components/schemas/CreatedAt'
PermissionKeySecret:
description: Permission secret key
type: string
pattern: ^[\w\d\/+=]{1,40}$
example: /NOTICE==EXISTS+ONLY+WHEN+JUST+CREATED/
PlanItem:
type: object
required:
- service_class_path
- type
- cluster_id
- capacity_gib
- fee
properties:
service_class_path:
$ref: '#/components/schemas/ServiceClassPath'
type:
$ref: '#/components/schemas/model.PlanType'
cluster_id:
type: string
example: isk01
capacity_gib:
type: integer
example: 20000
fee:
type: object
required:
- for_month
- monthly
- daily
- hourly
description: Fee information (tax included)
properties:
for_month:
type: integer
example: 1980
monthly:
type: integer
example: 7200
daily:
type: integer
example: 360
hourly:
type: integer
example: 36
BucketBillingItemDetail:
description: Charge information
type: object
required:
- found
- usage
- charge
- is_closing
- from
- to
properties:
found:
type: boolean
example: true
description: Whether billing record was found or not. `false` means that bucket was not found, bucket was owned by other accounts, or error on metering.
usage:
type: number
format: double
example: 1100.0
description: Usage for calculating charge
charge:
type: integer
example: 456
description: Amount billed including tax
is_closing:
type: boolean
example: true
description: Result of monthly closing or not
from:
type: string
format: date
example: '2022-08-01'
description: The first day of metering range
to:
type: string
format: date
example: '2022-08-31'
description: The last day of metering range
BucketBillingItem:
description: Bucket usage and charge for metering
type: object
required:
- year_month
- basic
- storage_usage
- num_objects
- num_transactions
- transfer_amount
properties:
year_month:
type: string
example: 2022-08
description: 集計対象の年月
basic:
$ref: '#/components/schemas/BucketBillingItemDetail'
description: 基本料金
storage_usage:
$ref: '#/components/schemas/BucketBillingItemDetail'
description: ストレージ使用量
num_objects:
$ref: '#/components/schemas/BucketBillingItemDetail'
description: オブジェクト数
num_transactions:
$ref: '#/components/schemas/BucketBillingItemDetail'
description: トランザクション数
transfer_amount:
$ref: '#/components/schemas/BucketBillingItemDetail'
description: 転送量
Quota:
description: Quota
type: object
required:
- data
properties:
data:
description: data type
type: object
required:
- num_root_keys
- num_buckets
- num_permissions
- num_keys_per_permission
- num_buckets_per_permission
- num_objects_per_bucket
- amount_gib_per_bucket
properties:
num_root_keys:
type: integer
example: 1
num_buckets:
type: integer
example: 20
num_permissions:
type: integer
example: 30
num_keys_per_permission:
type: integer
example: 1
num_buckets_per_permission:
type: integer
example: 20
num_objects_per_bucket:
type: integer
example: 10000000
amount_gib_per_bucket:
type: number
format: float
example: 10240
problem_details_429:
type: object
properties:
type:
type: string
format: uri
example: about:blank
title:
type: string
enum:
- throttled
description: 'エラー内容を示す簡潔な識別子
* `throttled` - リクエスト数制限に達している'
detail:
type: string
description: 人間のためのエラーメッセージ
status:
type: integer
description: HTTPステータスコード
example: 429
password_input:
type: string
format: password
example: passw0rd
minLength: 8
maxLength: 32
pattern: '[0-9a-zA-Z!"#$%&''()*+,\-./:;<=>?@[\]^_`{|}~]+'
description: '英数字と記号の組み合わせ
1文字以上のアルファベットと1文字以上の数字が必須'
problem_details_404:
type: object
properties:
type:
type: string
format: uri
example: about:blank
title:
type: string
enum:
- not_found
description: 'エラー内容を示す簡潔な識別子
* `not_found` - 未検出'
detail:
type: string
description: 人間のためのエラーメッセージ
status:
type: integer
description: HTTPステータスコード
example: 404
tag:
type: object
properties:
tag_id:
type: integer
description: タグID
example: 1
label:
type: string
description: タグの名称
example: タグ入力例
color:
type:
- string
- 'null'
description: タグの色
example: ffffff
problem_details_503:
type: object
properties:
type:
type: string
format: uri
example: about:blank
title:
type: string
enum:
- temporary_unavailable
description: 'エラー内容を示す簡潔な識別子
* `temporary_unavailable` - 一時的に利用不可'
detail:
type: string
description: 人間のためのエラーメッセージ
status:
type: integer
description: HTTPステータスコード
example: 503
invalid_parameter_detail:
type: array
items:
type: object
properties:
code:
type: string
description: エラー内容を示す簡潔な識別子
example: required
message:
type: string
description: 人間のためのエラーメッセージ
example: この項目は必須です
problem_details_409:
type: object
properties:
type:
type: string
format: uri
example: about:blank
title:
type: string
enum:
- conflict
description: 'エラー内容を示す簡潔な識別子
* `conflict` - 競合を検出'
detail:
type: string
description: 人間のためのエラーメッセージ
status:
type: integer
description: HTTPステータスコード
example: 409
interface_port:
type: object
description: ネットワークインターフェースの接続ポート情報
properties:
port_id:
type: integer
description: ポートID
example: 1
nickname:
type: string
description: インターフェース名称
example: インターフェース 1234abcd
port_channel_id:
type: integer
description: 所属ポートチャネルID
example: 1
mode:
type:
- string
- 'null'
enum:
- access
- trunk
description: 動作モード(初期化後の未設定時は`null`)
global_bandwidth_mbps:
type:
- integer
- 'null'
description: 'グローバル側の帯域幅(Mbps)
ボンディングされている場合は合計値'
example: 100
local_bandwidth_mbps:
type:
- integer
- 'null'
description: 'ローカル側の帯域幅(Mbps)
ボンディングされている場合は合計値'
example: 1000
enabled:
type: boolean
description: ポート有効状態(通信が有効になっている場合 `true`)
internet:
type:
- object
- 'null'
description: 'グローバルネットワーク情報
このポートにインターネット接続が割り当てられていない場合は`null`'
properties:
subnet_type:
type: string
enum:
- common_subnet
- dedicated_subnet
description: 'グローバルネットワーク分類
* `common_subnet` - 共用グローバルネットワークのIPアドレスを割り当て
* `dedicated_subnet` - 専用グローバルネットワーク割り当て'
dedicated_subnet:
type:
- object
- 'null'
description: 専用グローバルネットワーク情報(共用グローバルネットワーク割り当て時は`null`)
properties:
dedicated_subnet_id:
type: string
description: 専用グローバルネットワークのサービスコード
example: '345678901234'
nickname:
type: string
description: 専用グローバルネットワークに設定した名称
example: グローバルネットワーク名
network_address:
type: string
format: ipv4
description: ネットワークアドレス
example: 192.0.2.0
prefix_length:
type: integer
example: 24
description: ネットワーク長
private_networks:
type: array
items:
type: object
description: ローカルネットワーク情報
properties:
private_network_id:
type: string
description: ローカルネットワークID
example: '234567890123'
nickname:
type: string
description: ローカルネットワークに設定した名称
example: ローカルネットワーク名
port_channel:
type: object
description: ネットワークインターフェース ポートチャネル情報
properties:
port_channel_id:
type: integer
description: ポートチャネルID
example: 1
bonding_type:
type: string
enum:
- lacp
- static
- single
description: 'ボンディング方式
* `lacp` - LACP
* `static` - static link aggregation
* `single` - ボンディングなし(単体構成)'
ports:
type: array
description: ポートチャネルを構成するポートIDのリスト
items:
type: integer
description: ポートID
maxItems: 2
minItems: 2
example:
- 1
- 2
locked:
type: boolean
description: 設定変更によるロック状態(ロック中の場合は `true`)
link_speed_type:
type: string
enum:
- 1gbe
- 10gbe
description: '提供速度分類
* `1gbe` - 1GbE
* `10gbe` - 10GbE'
problem_details_400:
type: object
properties:
type:
type: string
format: uri
example: about:blank
title:
type: string
enum:
- invalid
- parse_error
description: 'エラー内容を示す簡潔な識別子
* `invalid` - 不正なリクエスト値,リクエスト値が妥当でない
* `parse_error` - 不正な形式,リクエスト値を読み取ることができない'
detail:
type: string
description: 人間のためのエラーメッセージ
status:
type: integer
description: HTTPステータスコード
example: 400
invalid_parameters:
description: '入力値に対するエラーを構造化した情報
(titleが`invalid`の場合のみ)
* `non_field_errors` - リクエスト全体に起因した(単一項目でない)エラー内容
* `*` - 対応した入力項目ごとのエラー内容'
example:
foo:
- code: required
message: この項目は必須です
type:
- object
- 'null'
properties:
non_field_errors:
$ref: '#/components/schemas/invalid_parameter_detail'
additionalProperties:
$ref: '#/components/schemas/invalid_parameter_detail'
paginate_meta:
type: object
properties:
count:
type: integer
description: 総件数
example: 10
service_quiet:
type: object
description: サービス情報
properties:
service_id:
type: string
description: サービスコード
example: '123456789012'
nickname:
type: string
example: サーバーやネットワークの簡潔な名前
description: 名称:サーバーやネットワークなどの表示名
description:
type:
- string
- 'null'
example: 'サーバーやネットワークの利用用途などを
自由に記述'
description: メモ:サーバーやネットワークなどの説明
activated:
type: string
format: date-time
description: 利用開始日時
tags:
type: array
items:
$ref: '#/components/schemas/tag'
server:
type: object
properties:
server_id:
type: string
description: サーバーのサービスコード
example: '123456789012'
service:
$ref: '#/components/schemas/service_quiet'
zone:
type: object
properties:
zone_id:
type: integer
description: ネットワークゾーンID
example: 303
region:
type: string
description: 地域名
example: 石狩
spec:
type: object
properties:
cpu_model_name:
type: string
description: CPU製品モデル名
example: Broadwell E5-2620v4
cpu_count:
type: integer
description: 物理CPU数
example: 1
cpu_core_count:
description: 総CPUコア数
type: integer
example: 8
cpu_clock_speed:
type: string
description: CPUクロック数(GHz)
example: '2.1'
memory_size:
type: integer
description: 総メモリ数(GB)
example: 48
port_channel_1gbe_count:
type: integer
description: 1GbEネットワークインターフェース ポートチャネル数
example: 1
port_channel_10gbe_count:
type: integer
description: 10GbEネットワークインターフェース ポートチャネル数
example: 1
storages:
type: array
description: 'ストレージ構成情報
同一構成(接続方式,記録方式,容量)ごとの配列'
items:
type: object
properties:
size:
type: integer
description: ストレージ1つあたりの容量(GB)
example: 10000
bus_type:
type: string
enum:
- sata
- sas
- nvme
description: 'ストレージ接続方式
* `sata` - SATA
* `sas` - SAS
* `nvme` - NVMe(PCIe)'
media_type:
type: string
enum:
- hdd
- ssd
- flash_memory
description: 'ストレージ記録方式
* `hdd` - 磁気HDD
* `ssd` - SSD
* `flash_memory` - Flash Memory(不揮発性メモリ)'
device_count:
type: integer
description: ストレージ構成物理デバイス数
example: 2
total_storage_device_count:
type: integer
description: ストレージ構成物理デバイス数の合計
example: 2
cached_power_status:
type:
- object
- 'null'
description: キャッシュされた電源状態(未キャッシュならば`null`)
properties:
status:
type: string
enum:
- 'on'
- 'off'
description: 電源状態
stored:
type: string
format: date-time
description: 電源状態キャッシュの保存時刻
ipv4:
type:
- object
- 'null'
description: グローバルIPアドレス割り当て情報(未設定時は`null`)
properties:
type:
type: string
enum:
- common_ip_address
- dedicated_ip_address
description: 'IPアドレスの種類
* `common_ip_address` - 共用グローバルネットワークのIPアドレス
* `dedicated_ip_address` - 専用グローバルネットワークのIPアドレス(割り当て設定が必要)'
ip_address:
type: string
format: ipv4
description: IPアドレス
example: 192.0.2.10
network_address:
type: string
format: ipv4
description: ネットワークアドレス
example: 192.0.2.0
prefix_length:
type: integer
example: 24
description: ネットワーク長
gateway_address:
type: string
format: ipv4
description: ゲートウェイアドレス
example: 192.0.2.1
name_servers:
type: array
description: DNSサーバーリスト
items:
type: string
format: ipv4
description: DNSサーバーIPアドレス
example: 192.0.2.200
port_channels:
type: array
items:
$ref: '#/components/schemas/port_channel'
ports:
type: array
items:
$ref: '#/components/schemas/interface_port'
lock_status:
type:
- string
- 'null'
enum:
- os_install
- configure_raid
- administrative_lock
description: '設定変更処理によるロック状態
`null`以外がセットされている場合は
OS再インストール,ネットワークIF設定(VLAN,通信無効など),電源操作を受け付けない
* `os_install` - OSインストール処理中
* `configure_raid` - RAID設定処理中
* `administrative_lock` - 機器交換,増設などの作業を行っている
* `null` - 設定変更を行っていない(処理を完了している)'
service:
type: object
properties:
service_id:
type: string
example: '123456789012'
nickname:
type: string
example: サーバーやネットワークの簡潔な名前
description: 名称:サーバーやネットワークなどの表示名
description:
type:
- string
- 'null'
example: 'サーバーやネットワークの利用用途などを
自由に記述'
description: メモ:サーバーやネットワークなどの説明
activated:
type: string
format: date-time
description: 利用開始日時
product_category:
type: string
example: server
enum:
- server
- dedicated_subnet
- private_network
- firewall
- load_balancer
description: 'サービスの種類
* `server` - サーバー
* `dedicated_subnet` - 専用グローバルネットワーク
* `private_network` - ローカルネットワーク
* `firewall` - ファイアウォール
* `load_balancer` - ロードバランサー'
tags:
type: array
items:
$ref: '#/components/schemas/tag'
plan:
type:
- object
- 'null'
description: プラン情報(ローカルネットワークの場合は`null`)
properties:
plan_id:
type: string
example: st-f-1cpu-1804_monthly
name:
type: string
example: 月払い 専用サーバ Fujitsu RX2530 M2 Xeon 8Core (18-04)
option_plans:
type: array
items:
type: object
properties:
plan_id:
type: string
description: プランID
example: opt-mem-48g
name:
type: string
example: 月払い OP・専用サーバ メモリ U/G RX2530M2 48GB増設 (Fujitsu) (16-12)
description: プラン名称
option_class:
type: string
enum:
- upgrade_memory
- upgrade_storage
- additional_storage1
- additional_storage2
- additional_storage3
- additional_nvme_storage1
- additional_nvme_storage2
- os
- global_bandwidth
- local_bandwidth
description: 'オプション申込区分
* `upgrade_memory` - 拡張メモリ
* `upgrade_storage` - ストレージ変更
* `additional_storage1` - 追加ストレージ1
* `additional_storage2` - 追加ストレージ2
* `additional_storage3` - 追加ストレージ3
* `additional_nvme_storage1` - 追加NVMeストレージ1
* `additional_nvme_storage2` - 追加NVMeストレージ2
* `os` - 有償OS
* `global_bandwidth` - インターネット帯域オプション
* `local_bandwidth` - ローカルネットワーク帯域オプション'
private_network:
type: object
properties:
private_network_id:
description: ローカルネットワークのID
type: string
example: '123456789012'
service:
$ref: '#/components/schemas/service_quiet'
zone:
type: object
properties:
zone_id:
type: integer
description: ネットワークゾーンID
example: 303
region:
type: string
description: 地域名
example: 石狩
vlan_id:
type: integer
description: VLAN ID
example: 3000
hybrid:
type: object
properties:
service_id:
type: string
description: ハイブリッド接続のサービスコード
destinations:
type: array
items:
type: object
properties:
destination_side_id:
type: string
description: 接続先サービスでの一意なネットワーク識別子
example: '567890123456'
service_name:
type: string
description: 接続先を分類する名称
example: クラウド石狩第1ゾーン
bridge_service_id:
type: string
description: 接続先別ハイブリッド接続のサービスコード
example: '678901234567'
server_count:
type: integer
description: 接続済みサーバー数
example: 1
dedicated_subnet:
type: object
properties:
dedicated_subnet_id:
type: string
description: 専用グローバルネットワークのサービスコード
example: '123456789012'
service:
$ref: '#/components/schemas/service_quiet'
zone:
type: object
properties:
zone_id:
type: integer
description: ネットワークゾーンID
example: 303
region:
type: string
description: 地域名
example: 石狩
ipv4:
type: object
properties:
network_address:
type: string
format: ipv4
description: ネットワークアドレス
example: 192.0.2.224
prefix_length:
type: integer
description: ネットワーク長
example: 28
gateway_address:
type: string
format: ipv4
description: ゲートウェイアドレス
example: 192.0.2.225
broadcast_address:
type: string
format: ipv4
description: ブロードキャストアドレス
example: 192.0.2.239
special_use_addresses:
type: array
description: 特別な用途で割り当て済みのIPアドレスのリスト
items:
$ref: '#/components/schemas/ipam'
ipv6:
type: object
properties:
enabled:
type: boolean
description: IPv6が有効になっているか
network_address:
type: string
format: ipv6
description: ネットワークIPアドレス
prefix_length:
type: integer
description: ネットワーク長
example: 64
gateway_address:
type: string
format: ipv6
description: ゲートウェイアドレス
broadcast_address:
type: string
format: ipv6
description: ブロードキャストアドレス
special_use_addresses:
type: array
description: 特別な用途で割り当て済みのIPアドレスのリスト
items:
type: object
properties:
ip_address:
type: string
format: ipv6
type:
type: string
enum:
- gateway
- gateway_real
description: '割り当て用途分類
* `gateway` - ゲートウェイアドレス
* `gateway_real` - ゲートウェイ機器実機'
server_count:
type: integer
description: 割り当て済みサーバー数
example: 1
firewall:
type:
- object
- 'null'
description: 割り当て済みファイアウォール(利用していない場合は`null`)
properties:
firewall_id:
type: string
description: ファイアウォールのサービスコード
example: '234567890123'
nickname:
type: string
description: ファイアウォールの名称
example: FW名
load_balancer:
description: 割り当て済みロードバランサー(利用していない場合は`null`)
properties:
load_balancer_id:
type:
- string
- 'null'
description: ロードバランサーのサービスコード
example: '345678901234'
nickname:
type: string
description: ロードバランサーの名称
example: LB名
config_status:
type: string
enum:
- operational
- configure_lb
- configure_fw
- enable_ipv6
- administrative_lock
description: '設定変更によるロック状態
`operational` 以外の状態では各種設定変更は不可
* `operational` - 操作可能
* `configure_lb` - LBを設定中
* `configure_fw` - FWを設定中
* `enable_ipv6` - IPv6設定中
* `administrative_lock` - 機器交換などの作業を行っている'
ipam:
type: object
properties:
ip_address:
type: string
format: ipv4
description: 専用グローバルネットワークのIPアドレス
description:
type: string
example: '説明文の
中身'
description: IPアドレスに対しての説明文
type:
type: string
enum:
- gateway
- gateway_real
- load_balancer
- server
- void
description: '割り当て用途分類
* `gateway` - ゲートウェイアドレス
* `gateway_real` - ゲートウェイ機器実機
* `load_balancer` - ロードバランサー
* `server` - サーバー
* `void` - 用途登録なし'
example: server
server:
type:
- object
- 'null'
properties:
server_id:
type: string
description: サーバーのサービスコード(用途分類が`server`の場合のみ)
example: '123456789012'
nickname:
type: string
description: サーバーの名称
example: サーバー名
use_rdns:
type: boolean
description: 逆引きDNSを設定しているか否か(設定済みの場合 `true`)
NotFound:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: number
enum:
- 404
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
enum:
- not_found
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: 'リクエストされたリソースが見つからない場合のエラー。
リソースが存在しない、またはアクセスできない場合に返される。'
Forbidden:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: number
enum:
- 403
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
enum:
- forbidden
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: 'サーバーがリクエストを理解したが認可を拒否した場合のエラー。
ユーザーにリソースへのアクセス権限がない場合に返される。'
UnexpectedError:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: integer
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: '標準的な問題詳細に該当しない予期しないエラー用の汎用エラーモデル。
API処理中に発生する予期しないエラーを扱うために使用。'
Unauthorized:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: number
enum:
- 401
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
enum:
- authentication_failed
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: '認証が必要なリクエスト。
ユーザーが認証されていない、または認証トークンが無効な場合に返されるエラー。'
TooManyRequests:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: number
enum:
- 429
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
enum:
- too_many_requests
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: 'クライアントが一定期間内に過剰なリクエストを送信した場合のエラー。
レートリミットに達した場合に返される。'
clientDelaySeconds:
type: integer
description: レスポンスを受信してから遅延する秒数を示す負でない 10 進数の整数。
ActivationCreateInput:
type: object
required:
- servicePrincipalId
properties:
servicePrincipalId:
type: string
description: プロジェクトに紐づくサービスプリンシパルID(評価対象リソースへのアクセス権限付与)。
description: 新規プロジェクトのセキュリティコントロール有効化時に使用するリクエストボディ。
clientRetryDateTime:
type: string
format: date-time
description: '再試行する日付。HTTP の日付形式の詳細については RFC 7231, セクション 7.1.1.2: Date を参照。'
BadRequest:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: number
enum:
- 400
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
enum:
- invalid
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: サーバーがリクエストのパラメータやペイロードを理解できなかった場合のエラー。
ActivationUpdateInput:
type: object
required:
- servicePrincipalId
- isActive
properties:
servicePrincipalId:
type: string
description: プロジェクトに紐づくサービスプリンシパルID(評価対象リソースへのアクセス権限付与)。
isActive:
type: boolean
description: 現在のプロジェクトで「セキュリティコントロール」が有効かどうか。
description: 有効化状態更新時のリクエストボディ
ActivationOutput:
type: object
required:
- servicePrincipalId
- isActive
- automatedActionLimit
properties:
servicePrincipalId:
type: string
description: プロジェクトに紐づくサービスプリンシパルID(評価対象リソースへのアクセス権限付与)。
isActive:
type: boolean
description: 現在のプロジェクトで「セキュリティコントロール」が有効かどうか。
automatedActionLimit:
type: integer
description: 登録可能な自動アクションの最大数。
readOnly: true
description: '現在のプロジェクトにおける「セキュリティコントロール」有効化状態を返すレスポンスボディ。
基本情報に加えて、システム内部で定義された追加情報を含む。'
Conflict:
type: object
properties:
type:
type: string
format: uri-reference
description: 問題の種類を識別するURI参照。
title:
type: string
description: 問題の種類の簡潔な説明。本APIの運用規約により、このフィールドは常に設定される。
status:
type: number
enum:
- 409
description: この問題のHTTPステータスコード。本APIの運用規約により、このフィールドは常に設定される。
detail:
type: string
enum:
- conflict
description: この問題の詳細な説明。
instance:
type: string
format: uri-reference
description: この問題の発生を識別するURI参照。
description: 'リクエストが現在のリソースの状態と競合した場合のエラー。
例えば、既に存在するリソースを再度作成しようとした場合などに返される。'
ActionDefinitionWorkflows:
type: object
required:
- actionType
- actionParameter
properties:
actionType:
type: string
enum:
- workflows
actionParameter:
$ref: '#/components/schemas/SakuraWorkflows'
AutomatedActionInput:
type: object
required:
- name
- action
- executionCondition
- isEnabled
properties:
name:
type: string
description: 自動アクションの名称。
description:
type: string
description: 自動アクションの説明。
action:
allOf:
- $ref: '#/components/schemas/ActionDefinition'
description: アクションの定義(アクションタイプごとに異なる)。
executionCondition:
type: string
description: 'どのような条件で自動アクションを実行するかの条件式。
この条件式を満たした場合にのみ、自動アクションが実行される。
CEL(Common Expression Language)形式で記述する。'
isEnabled:
type: boolean
description: 自動アクションが有効かどうか。
description: 自動アクションを作成または更新する際に使用するリクエストボディ。
ActionDefinitionSimpleNotification:
type: object
required:
- actionType
- actionParameter
properties:
actionType:
type: string
enum:
- simpleNotification
actionParameter:
$ref: '#/components/schemas/SakuraSimpleNotification'
AutomatedActionOutput:
type: object
required:
- automatedActionId
- name
- action
- executionCondition
- isEnabled
- createdAt
properties:
automatedActionId:
allOf:
- $ref: '#/components/schemas/AutomatedActionID'
description: 自動アクションの一意な識別子。
readOnly: true
name:
type: string
description: 自動アクションの名称。
description:
type: string
description: 自動アクションの説明。
action:
allOf:
- $ref: '#/components/schemas/ActionDefinition'
description: アクションの定義(アクションタイプごとに異なる)。
executionCondition:
type: string
description: 'どのような条件で自動アクションを実行するかの条件式。
この条件式を満たした場合にのみ、自動アクションが実行される。
CEL(Common Expression Language)形式で記述する。'
isEnabled:
type: boolean
description: 自動アクションが有効かどうか。
createdAt:
type: string
format: date-time
description: 自動アクションの作成日時。
readOnly: true
description: '自動アクションの現在の状態を取得するためのレスポンスボディ。
基本情報に加えて、識別子や作成日時など、システムによって付与される情報を含む。'
SakuraSimpleNotification:
type: object
required:
- servicePrincipalId
- notificationGroupId
properties:
servicePrincipalId:
type: string
description: 'さくらのクラウドの作成・削除権限を持つサービスプリンシパルID。
このサービスプリンシパルには `作成・削除` ロールが付与されている必要がある。
付与されていない場合、自動アクションの実行に失敗する。'
notificationGroupId:
type: string
description: 通知先グループID
SakuraWorkflows:
type: object
required:
- servicePrincipalId
- workflowId
properties:
servicePrincipalId:
type: string
description: 'さくらのクラウドの作成・削除権限を持つサービスプリンシパルID。
このサービスプリンシパルには `ワークフロー` ロールが付与されている必要がある。
付与されていない場合、自動アクションの実行に失敗する。'
workflowId:
type: string
description: ワークフローID
revisionId:
type: integer
description: '実行したいワークフローのリビジョンID。
指定しない場合は最新のリビジョンが使用される。'
revisionAlias:
type: string
description: '実行したいリビジョンのエイリアス。
指定しない場合は最新のリビジョンが使用される。'
args:
type: string
description: '実行時にワークフローへ渡す引数(JSON文字列)。
引数を要求するワークフローの場合は指定が必須。
例: `{\"server_id\": 12345}`'
name:
type: string
description: ワークフロー実行名。
AutomatedActionID:
type: string
description: 自動アクションの一意な識別子。
ActionDefinition:
type: object
oneOf:
- $ref: '#/components/schemas/ActionDefinitionSimpleNotification'
- $ref: '#/components/schemas/ActionDefinitionWorkflows'
discriminator:
propertyName: actionType
mapping:
simpleNotification: '#/components/schemas/ActionDefinitionSimpleNotification'
workflows: '#/components/schemas/ActionDefinitionWorkflows'
EvaluationRuleInput:
type: object
required:
- rule
- isEnabled
properties:
rule:
$ref: '#/components/schemas/EvaluationRuleUnion'
isEnabled:
type: boolean
description: ルールが有効かどうか。
description: 評価ルールの更新に使用するリクエストボディ。
EvaluationRuleParameters.ObjectStorageEvaluationTarget:
type: object
properties:
servicePrincipalId:
type: string
description: 評価対象リソースに対する読み取り権限を持つサービスプリンシパルのID。未指定の場合はセキュリティコントロール有効化時に設定されたサービスプリンシパルが使用される。
sites:
type: array
items:
type: string
description: 評価対象のオブジェクトストレージ用サイトを指定。未指定または空配列の場合はすべてのサイトが対象となる。
description: 'サービスプリンシパルIDと評価対象のオブジェクトストレージ用サイト配列を要求するパラメータ。
オブジェクトストレージに関連する評価ルールで使用される。
`sites == []` の場合は「全サイト対象」の意味。'
ObjectStorageBucketACLChanged:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- objectstorage-bucket-acl-changed
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.EvaluationTarget'
examples:
- servicePrincipalId: '1'
ELBLoggingEnabled:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- elb-logging-enabled
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.EvaluationTarget'
examples:
- servicePrincipalId: '1'
DiskEncryptionEnabled:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- disk-encryption-enabled
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ZonedEvaluationTarget'
examples:
- servicePrincipalId: '1'
zones:
- tk1a
- is1a
- is1b
- servicePrincipalId: '1'
zones: []
ServerNoPublicIP:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- server-no-public-ip
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ZonedEvaluationTarget'
examples:
- servicePrincipalId: '1'
zones:
- tk1a
- is1a
- is1b
- servicePrincipalId: '1'
zones: []
EvaluationRuleID:
type: string
enum:
- server-no-public-ip
- disk-encryption-enabled
- dba-encryption-enabled
- dba-no-public-ip
- objectstorage-bucket-acl-changed
- objectstorage-bucket-encryption-enabled
- addon-datalake-no-public-access
- addon-dwh-no-public-access
- addon-threat-detection-enabled
- elb-logging-enabled
- iam-member-operation-detected
- nosql-encryption-enabled
- addon-threat-detections
- addon-vulnerability-detections
EvaluationRuleUnion:
type: object
oneOf:
- $ref: '#/components/schemas/ServerNoPublicIP'
- $ref: '#/components/schemas/DiskEncryptionEnabled'
- $ref: '#/components/schemas/DbaEncryptionEnabled'
- $ref: '#/components/schemas/DbaNoPublicIP'
- $ref: '#/components/schemas/ObjectStorageBucketACLChanged'
- $ref: '#/components/schemas/ObjectStorageBucketEncryptionEnabled'
- $ref: '#/components/schemas/AddonDatalakeNoPublicAccess'
- $ref: '#/components/schemas/AddonDwhNoPublicAccess'
- $ref: '#/components/schemas/AddonThreatDetectionEnabled'
- $ref: '#/components/schemas/ELBLoggingEnabled'
- $ref: '#/components/schemas/IAMMemberOperationDetected'
- $ref: '#/components/schemas/NoSQLEncryptionEnabled'
- $ref: '#/components/schemas/AddonThreatDetections'
- $ref: '#/components/schemas/AddonVulnerabilityDetections'
discriminator:
propertyName: evaluationRuleId
mapping:
server-no-public-ip: '#/components/schemas/ServerNoPublicIP'
disk-encryption-enabled: '#/components/schemas/DiskEncryptionEnabled'
dba-encryption-enabled: '#/components/schemas/DbaEncryptionEnabled'
dba-no-public-ip: '#/components/schemas/DbaNoPublicIP'
objectstorage-bucket-acl-changed: '#/components/schemas/ObjectStorageBucketACLChanged'
objectstorage-bucket-encryption-enabled: '#/components/schemas/ObjectStorageBucketEncryptionEnabled'
addon-datalake-no-public-access: '#/components/schemas/AddonDatalakeNoPublicAccess'
addon-dwh-no-public-access: '#/components/schemas/AddonDwhNoPublicAccess'
addon-threat-detection-enabled: '#/components/schemas/AddonThreatDetectionEnabled'
elb-logging-enabled: '#/components/schemas/ELBLoggingEnabled'
iam-member-operation-detected: '#/components/schemas/IAMMemberOperationDetected'
nosql-encryption-enabled: '#/components/schemas/NoSQLEncryptionEnabled'
addon-threat-detections: '#/components/schemas/AddonThreatDetections'
addon-vulnerability-detections: '#/components/schemas/AddonVulnerabilityDetections'
EvaluationRuleParameters.EvaluationTarget:
type: object
properties:
servicePrincipalId:
type: string
description: 評価対象リソースに対する読み取り権限を持つサービスプリンシパルのID。未指定の場合はセキュリティコントロール有効化時に設定されたサービスプリンシパルが使用される。
description: すべての評価ルールに共通する最小セットのパラメータ。
AddonDwhNoPublicAccess:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- addon-dwh-no-public-access
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.EvaluationTarget'
examples:
- servicePrincipalId: '1'
AddonVulnerabilityDetections:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- addon-vulnerability-detections
DbaEncryptionEnabled:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- dba-encryption-enabled
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ZonedEvaluationTarget'
examples:
- servicePrincipalId: '1'
zones:
- tk1a
- is1a
- is1b
- servicePrincipalId: '1'
zones: []
NoSQLEncryptionEnabled:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- nosql-encryption-enabled
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ZonedEvaluationTarget'
examples:
- servicePrincipalId: '1'
zones:
- tk1a
- is1a
- is1b
- servicePrincipalId: '1'
zones: []
EvaluationRuleParameters.ZonedEvaluationTarget:
type: object
properties:
servicePrincipalId:
type: string
description: 評価対象リソースに対する読み取り権限を持つサービスプリンシパルのID。未指定の場合はセキュリティコントロール有効化時に設定されたサービスプリンシパルが使用される。
zones:
type: array
items:
type: string
description: 評価対象ゾーンを指定。未指定または空配列の場合はすべてのゾーンが対象となる。
description: 'サービスプリンシパルIDと評価対象ゾーン配列を要求するパラメータ。
`zones == []` の場合は「全ゾーン対象」の意味。'
EvaluationRule:
type: object
required:
- rule
- iamRolesRequired
- isEnabled
properties:
rule:
$ref: '#/components/schemas/EvaluationRuleUnion'
description:
type: string
description: 評価ルールの説明。
readOnly: true
iamRolesRequired:
type: array
items:
type: string
description: 評価ルールを適用するために必要なIAMロールの一覧。
readOnly: true
isEnabled:
type: boolean
description: ルールが有効かどうか。
description: プロジェクトに適用できるセキュリティ評価ルールを表す。
DbaNoPublicIP:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- dba-no-public-ip
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ZonedEvaluationTarget'
examples:
- servicePrincipalId: '1'
zones:
- tk1a
- is1a
- is1b
- servicePrincipalId: '1'
zones: []
IAMMemberOperationDetected:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- iam-member-operation-detected
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.EvaluationTarget'
examples:
- servicePrincipalId: '1'
AddonThreatDetectionEnabled:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- addon-threat-detection-enabled
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ZonedEvaluationTarget'
examples:
- servicePrincipalId: '1'
zones:
- tk1a
- is1a
- is1b
- servicePrincipalId: '1'
zones: []
AddonDatalakeNoPublicAccess:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- addon-datalake-no-public-access
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.EvaluationTarget'
examples:
- servicePrincipalId: '1'
ObjectStorageBucketEncryptionEnabled:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- objectstorage-bucket-encryption-enabled
parameter:
allOf:
- $ref: '#/components/schemas/EvaluationRuleParameters.ObjectStorageEvaluationTarget'
examples:
- servicePrincipalId: '1'
sites:
- isk01
- tky01
- servicePrincipalId: '1'
sites: []
AddonThreatDetections:
type: object
required:
- evaluationRuleId
properties:
evaluationRuleId:
type: string
enum:
- addon-threat-detections
Models.Network.SimpleInterface:
type: object
required:
- IPAddress
- UserIPAddress
- Switch
properties:
IPAddress:
anyOf:
- type: string
- type: 'null'
description: IPアドレス
UserIPAddress:
anyOf:
- type: string
- type: 'null'
description: ユーザーIPアドレス
Switch:
type: object
properties:
Scope:
type: string
enum:
- user
- shared
description: スイッチのスコープ
required:
- Scope
description: スイッチ情報
Models.Appliance.ReadServiceEndpointGatewayInterfaceResponseBody:
type: object
required:
- Interface
- is_ok
properties:
Interface:
allOf:
- $ref: '#/components/schemas/Models.Network.SimpleInterface'
description: サービスエンドポイントゲートウェイのインターフェース情報
is_ok:
type: boolean
description: 操作結果
examples:
- Interface:
IPAddress: 203.0.113.100
UserIPAddress: null
Switch:
Scope: shared
is_ok: true
Models.Common.DefaultErrorResponseBody:
type: object
properties:
is_fatal:
type: boolean
serial:
type: string
status:
type: string
error_code:
type: string
error_msg:
type: string
Models.Instance.InstanceForPower:
type: object
required:
- Status
properties:
Status:
type: string
enum:
- up
- down
- cleaning
description: 稼働状態
Models.Power.ApplianceDeletePowerStatusRequest:
type: object
required:
- Force
properties:
Force:
type: boolean
description: 強制的にシャットダウンするかどうか
Models.Power.ReadServiceEndpointGatewayPowerStatusResponseBody:
type: object
required:
- Instance
- is_ok
properties:
Instance:
allOf:
- $ref: '#/components/schemas/Models.Instance.InstanceForPower'
description: サービスエンドポイントゲートウェイの稼働状態情報
is_ok:
type: boolean
description: 操作結果
examples:
- Instance:
Status: up
is_ok: true
Models.Power.UpdateServiceEndpointGatewayPowerStatusResponseBody:
type: object
required:
- Success
- is_ok
properties:
Success:
anyOf:
- type: boolean
- type: string
is_ok:
type: boolean
description: 操作結果
examples:
- Success: true
is_ok: true
ReorderNotificationRoutingRequest:
properties:
Orders:
items:
properties:
PriorityRank:
maximum: 100
minimum: 1
type: integer
RoutingID:
pattern: ^[0-9]{1,12}$
type: string
required:
- RoutingID
- PriorityRank
type: object
type: array
required:
- Orders
type: object
ListNotificationSourcesResponse:
type: object
properties:
Sources:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
required:
- id
- name
required:
- Sources
Error:
type: object
properties:
is_fatal:
type: boolean
serial:
type: string
status:
type: string
error_code:
type: string
error_msg:
type: string
ListCommonServiceItemsResponse:
type: object
properties:
From:
type: integer
Count:
type: integer
Total:
type: integer
CommonServiceItems:
type: array
items:
$ref: '#/components/schemas/CommonServiceItem'
required:
- CommonServiceItems
PutCommonServiceItemRequest:
type: object
properties:
CommonServiceItem:
type: object
properties:
Name:
type: string
Description:
type: string
Tags:
type: array
items:
type: string
Icon:
$ref: '#/components/schemas/CommonServiceItemIcon'
Settings:
oneOf:
- $ref: '#/components/schemas/CommonServiceItemDestinationSettings'
- $ref: '#/components/schemas/CommonServiceItemGroupSettings'
- $ref: '#/components/schemas/CommonServiceItemRoutingSettings'
required:
- Name
- Description
- Tags
- Icon
required:
- CommonServiceItem
CheckDestinationStatusResponse:
type: object
properties:
NotificationStatus:
type: object
properties:
IsValid:
type: boolean
ModifiedAt:
type: string
format: date-time
required:
- IsValid
- ModifiedAt
required:
- NotificationStatus
CommonServiceItemIcon:
type:
- object
- 'null'
properties:
ID:
type: string
URL:
type: string
Name:
type: string
Scope:
type: string
required:
- ID
CommonServiceItemGroupSettings:
type: object
properties:
Destinations:
type: array
items:
type: string
pattern: ^[0-9]{12}$
Disabled:
type: boolean
required:
- Destinations
PostCommonServiceItemRequest:
type: object
properties:
CommonServiceItem:
type: object
properties:
Name:
type: string
Description:
type: string
Tags:
type: array
items:
type: string
Icon:
$ref: '#/components/schemas/CommonServiceItemIcon'
Provider:
properties:
Class:
type: string
enum:
- saknoticedestination
- saknoticegroup
- saknoticerouting
Name:
type: string
ServiceClass:
type: string
required:
- Class
type: object
Settings:
oneOf:
- $ref: '#/components/schemas/CommonServiceItemDestinationSettings'
- $ref: '#/components/schemas/CommonServiceItemGroupSettings'
- $ref: '#/components/schemas/CommonServiceItemRoutingSettings'
ServiceClass:
type: string
enum:
- cloud/saknoticedestination/2
- cloud/saknoticegroup/2
- cloud/saknoticerouting/2
required:
- Name
- Description
- Tags
- Icon
- Provider
- Settings
- ServiceClass
required:
- CommonServiceItem
CommonServiceItemRoutingSettings:
type: object
properties:
MatchLabels:
items:
properties:
Name:
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9_-]*$
Value:
type: string
maxLength: 64
pattern: ^[\x20-\x7E]*$
required:
- Name
- Value
type: object
type: array
SourceID:
pattern: ^[0-9]{1,12}$
type: string
TargetGroupID:
pattern: ^[0-9]{1,12}$
type: string
PriorityRank:
maximum: 100
minimum: 1
type: integer
readOnly: true
required:
- SourceID
- MatchLabels
- TargetGroupID
- PriorityRank
CommonServiceItem:
type: object
properties:
Index:
type: integer
ID:
type: string
Name:
type: string
Description:
type: string
Settings:
oneOf:
- $ref: '#/components/schemas/CommonServiceItemDestinationSettings'
- $ref: '#/components/schemas/CommonServiceItemGroupSettings'
- $ref: '#/components/schemas/CommonServiceItemRoutingSettings'
CreatedAt:
type: string
format: date-time
ModifiedAt:
type: string
format: date-time
Provider:
type: object
properties:
Class:
type: string
enum:
- saknoticedestination
- saknoticegroup
- saknoticerouting
required:
- Class
Icon:
$ref: '#/components/schemas/CommonServiceItemIcon'
Tags:
type: array
items:
type: string
required:
- ID
- Name
- Description
- Settings
- CreatedAt
- ModifiedAt
- Provider
- Icon
- Tags
CommonServiceItemDestinationSettings:
type: object
properties:
Type:
type: string
enum:
- email
- webhook
Value:
type: string
Disabled:
type: boolean
required:
- Type
- Value
ListNotificationHistoriesResponse:
type: object
properties:
NotificationHistories:
type: array
items:
$ref: '#/components/schemas/NotificationHistory'
required:
- NotificationHistories
NotificationMessage:
type: object
properties:
body:
type: string
color:
type: string
color_code:
type: string
icon_url:
type: string
image_url:
type: string
title:
type: string
required:
- body
- color
- color_code
- icon_url
- image_url
- title
NotificationStatus:
type: object
properties:
id:
type: string
status:
type: integer
description: '- 0: 未送信
- 1: 送信中
- 2: 送信済
- 3: スキップ
- 9: 送信失敗
'
enum:
- 0
- 1
- 2
- 3
- 9
error_info:
type: string
notification_request_id:
type: string
group_id:
type: string
pattern: ^[0-9]{12}$
destination_id:
type: string
pattern: ^[0-9]{12}$
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
required:
- id
- status
- error_info
- notification_request_id
- group_id
- destination_id
- created_at
- updated_at
ReadNotificationHistoryResponse:
type: object
properties:
NotificationHistory:
$ref: '#/components/schemas/NotificationHistory'
required:
- NotificationHistory
NotificationHistory:
type: object
properties:
request_id:
type: string
source_id:
type: string
statuses:
type: array
items:
$ref: '#/components/schemas/NotificationStatus'
received_at:
type: string
format: date-time
message:
$ref: '#/components/schemas/NotificationMessage'
required:
- request_id
- source_id
- statuses
- received_at
- message
SendNotificationResponse:
type: object
properties:
is_ok:
type: boolean
required:
- is_ok
SendNotificationRequest:
type: object
properties:
Message:
type: string
maxLength: 2048
required:
- Message
responses:
ServerErrorResponse:
description: サーバーエラー
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
ConflictResponse:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
BadRequestResponse:
description: Requestエラー
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
NotFoundResponse:
description: リソースが存在しない
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
UnauthorizedResponse:
description: 認証エラー
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
UnprocessableEntityResponse:
description: Request自体は正しいが、処理できない
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
ServerErrorResponse_2:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_2:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_2:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
NotFoundResponse_2:
description: リソースが存在しない
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 404 Not Found
error_code:
type: string
description: エラーコード
example: not_found
error_msg:
type: string
description: エラーメッセージ
example: 対象が見つかりません。
UnauthorizedResponse_2:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_3:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_3:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_3:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
UnauthorizedResponse_3:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_4:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_4:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_4:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
UnauthorizedResponse_4:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_5:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_5:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_5:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
NotFoundResponse_3:
description: リソースが存在しない
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 404 Not Found
error_code:
type: string
description: エラーコード
example: not_found
error_msg:
type: string
description: エラーメッセージ
example: 対象が見つかりません。
UnauthorizedResponse_5:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_6:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_6:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_6:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
NotFoundResponse_4:
description: リソースが存在しない
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 404 Not Found
error_code:
type: string
description: エラーコード
example: not_found
error_msg:
type: string
description: エラーメッセージ
example: 対象が見つかりません。
UnauthorizedResponse_6:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
generic_401:
description: 未ログイン
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: HTTPステータスコード
example: 401 Unauthorized
error_code:
type: string
enum:
- unauthorized
description: エラー内容を示す簡潔な識別子
error_msg:
type: string
description: 人間のためのエラーメッセージ
example: error-unauthorized
generic_429:
description: リクエスト可能数に達している
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_429'
headers:
Retry-After:
description: リクエストが可能になるまでの秒数
schema:
type: integer
example: 3600
generic_400:
description: 入力値検証エラー
content:
application/json:
schema:
$ref: '#/components/schemas/problem_details_400'
ServerErrorResponse_7:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_7:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_7:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
NotFoundResponse_5:
description: リソースが存在しない
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 404 Not Found
error_code:
type: string
description: エラーコード
example: not_found
error_msg:
type: string
description: エラーメッセージ
example: 対象が見つかりません。
UnauthorizedResponse_7:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_8:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_8:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_8:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
UnauthorizedResponse_8:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_9:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_9:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_9:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
UnauthorizedResponse_9:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_10:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_10:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_10:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
NotFoundResponse_6:
description: リソースが存在しない
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 404 Not Found
error_code:
type: string
description: エラーコード
example: not_found
error_msg:
type: string
description: エラーメッセージ
example: 対象が見つかりません。
UnauthorizedResponse_10:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
ServerErrorResponse_11:
description: サーバエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 500 Internal Server Error
error_code:
type: string
description: エラーコード
example: internal_server_error
error_msg:
type: string
description: エラーメッセージ
example: サーバ内部エラーが発生しました。
ConflictResponse_11:
description: リソースが競合している
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictErrorResponse'
BadRequestResponse_11:
description: Requestエラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 400 Bad Request
error_code:
type: string
description: エラーコード
example: bad_request
error_msg:
type: string
description: エラーメッセージ
example: 不適切な要求です。
NotFoundResponse_7:
description: リソースが存在しない
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 404 Not Found
error_code:
type: string
description: エラーコード
example: not_found
error_msg:
type: string
description: エラーメッセージ
example: 対象が見つかりません。
UnauthorizedResponse_11:
description: 認証エラー
content:
application/json:
schema:
type: object
description: エラーレスポンス
properties:
is_fatal:
type: boolean
description: エラーのレスポンス(true:エラー)
example: true
serial:
type: string
description: 追跡コード
example: 3a5a51fdxxxxx5f6794e82cc8d00d3xx
status:
type: string
description: ステータス
example: 401 Unauthorized
error_code:
type: string
description: エラーコード
example: unauthorized
error_msg:
type: string
description: エラーメッセージ
example: この操作は認証が必要です。
parameters:
GroupID:
in: path
name: groupId
description: GroupID
schema:
type: string
format: uuid
example: ac8a3fb3-0354-4917-9a3d-c5dc5ab50869
required: true
example: ac8a3fb3-0354-4917-9a3d-c5dc5ab50869
SubscriptionID:
in: path
name: subscriptionId
description: SubscriptionID
schema:
type: string
format: uuid
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
required: true
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
RouteID:
in: path
name: routeId
description: RouteID
schema:
type: string
format: uuid
example: 02c6abbd-0c12-42e5-8d90-7eea021028d9
required: true
example: 02c6abbd-0c12-42e5-8d90-7eea021028d9
ServiceID:
name: serviceId
in: path
description: ServiceID
required: true
schema:
type: string
format: uuid
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
DomainID:
in: path
name: domainId
description: DomainID
schema:
type: string
format: uuid
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
required: true
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
UserID:
in: path
name: userId
description: UserID
schema:
type: string
format: uuid
example: 67f57741-ac25-433a-8d7a-8778711b4a2c
required: true
example: 67f57741-ac25-433a-8d7a-8778711b4a2c
CertificateID:
in: path
name: certificateId
description: CertificateID
schema:
type: string
format: uuid
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
required: true
example: 7c8d78bc-e4a3-4600-b70a-f5fe802dc1ba
ApplianceID:
name: applianceID
in: path
description: アプライアンスID
required: true
schema:
type: string
example: '113600102549'
BackupID:
name: backupID
in: path
description: バックアップID
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
header_requested_with:
in: header
name: X-Requested-With
description: CSRF防止用ヘッダー
required: true
schema:
type: string
enum:
- XMLHttpRequest
tag_filter:
in: query
name: tag
required: false
schema:
type: array
maxItems: 10
items:
type: string
maxLength: 50
description: タグ名
description: 'タグで絞り込む \
このクエリーパラメーターを複数指定した場合は **すべてのタグを設定済み(AND)** のものにマッチ'
style: form
explode: true
server_id:
in: path
name: server_id
required: true
schema:
type: string
pattern: ^\d{12}$
description: サーバーのサービスコード
limit:
in: query
name: limit
required: false
schema:
type: integer
default: 10
description: 取得数を指定する
offset:
in: query
name: offset
required: false
schema:
type: integer
default: 0
description: 取得開始位置を指定する
free_word_filter:
in: query
name: free_word
description: 'フリーワード検索
下記項目の **いずれか** にマッチしたものを抽出する
* 名前(部分一致)
* 説明(部分一致)
* タグ(部分一致)
このクエリーパラメーターを複数指定した場合は **複数の語句すべてを含む(AND)** ものにマッチ'
style: form
explode: true
schema:
type: array
maxItems: 5
items:
type: string
maxLength: 50
required: false
port_channel_id:
in: path
name: port_channel_id
required: true
schema:
type: integer
description: ポートチャネルID
port_id:
in: path
name: port_id
required: true
schema:
type: integer
description: ポートID
service_id:
in: path
name: service_id
required: true
schema:
type: string
pattern: ^\d{12}$
description: サービスコード
private_network_id:
in: path
name: private_network_id
required: true
schema:
type: string
pattern: ^\d{12}$
description: ローカルネットワークのサービスコード
dedicated_subnet_id:
in: path
name: dedicated_subnet_id
required: true
schema:
type: string
pattern: ^\d{12}$
description: 専用グローバルネットワークのサービスコード
examples:
PostCommonServiceItemRequestRouting:
value:
CommonServiceItem:
Name: test routing
Description: 通知ルーティングの説明
Tags: []
Icon:
ID: '123700100001'
Provider:
Class: saknoticerouting
Settings:
SourceID: '1'
MatchLabels:
- Name: environment
Value: development
TargetGroupID: '123700020001'
ServiceClass: cloud/saknoticerouting/2
ReadCommonServiceItemsResponseGroup:
value:
CommonServiceItem:
ID: '123700020001'
Name: test group
Description: 通知先グループの説明
Provider:
Class: saknoticegroup
Settings:
Destinations:
- '123700010001'
- '123700010002'
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
PutCommonServiceItemRequestRouting:
value:
CommonServiceItem:
Name: test routing
Description: 通知ルーティングの説明
Tags: []
Icon:
ID: '123700100001'
Settings:
SourceID: '1'
MatchLabels:
- Name: environment
Value: development
TargetGroupID: '123700020001'
ReadCommonServiceItemsResponseRouting:
value:
CommonServiceItem:
ID: '123700030001'
Name: test routing
Description: 通知ルーティングの説明
Provider:
Class: saknoticerouting
Settings:
SourceID: '1'
MatchLabels:
- Name: environment
Value: development
TargetGroupID: '123700020001'
PriorityRank: 1
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
ListCommonServiceItemsResponseRoutings:
value:
From: 0
Count: 1
Total: 1
CommonServiceItems:
- Index: 0
ID: '123700030001'
Name: test routing
Description: 通知ルーティングの説明
Provider:
Class: saknoticerouting
Settings:
SourceID: '1'
MatchLabels:
- Name: environment
Value: development
TargetGroupID: '123700020001'
PriorityRank: 1
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
PutCommonServiceItemRequestDestination:
value:
CommonServiceItem:
Name: mail destination
Description: メール通知先の説明
Tags: []
Icon:
ID: '123700100001'
Settings:
Type: email
Value: user@example.com
PutCommonServiceItemRequestGroup:
value:
CommonServiceItem:
Name: test group
Description: 通知先グループの説明
Tags: []
Icon:
ID: '123700100001'
Settings:
Destinations:
- '123700010001'
PostCommonServiceItemRequestGroup:
value:
CommonServiceItem:
Name: test group
Description: 通知先グループの説明
Tags: []
Icon:
ID: '123700100001'
Provider:
Class: saknoticegroup
Settings:
Destinations:
- '123700010001'
ServiceClass: cloud/saknoticegroup/2
ListCommonServiceItemsResponseDestinations:
value:
From: 0
Count: 2
Total: 2
CommonServiceItems:
- Index: 0
ID: '123700010001'
Name: mail destination
Description: メール通知先の説明
Provider:
Class: saknoticedestination
Settings:
Type: email
Value: user@example.com
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
- Index: 1
ID: '123700010002'
Name: webhook destination
Description: Webhook通知先の説明
Provider:
Class: saknoticedestination
Settings:
Type: webhook
Value: https://example.com/notify
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
ReadCommonServiceItemsResponseDestination:
value:
CommonServiceItem:
ID: '123700010001'
Name: mail destination
Description: メール通知先の説明
Provider:
Class: saknoticedestination
Settings:
Type: email
Value: user@example.com
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
PostCommonServiceItemRequestDestination:
value:
CommonServiceItem:
Name: mail destination
Description: メール通知先の説明
Tags: []
Icon:
ID: '123700100001'
Provider:
Class: saknoticedestination
Settings:
Type: email
Value: user@example.com
ServiceClass: cloud/saknoticedestination/2
ListCommonServiceItemsResponseGroups:
value:
From: 0
Count: 1
Total: 1
CommonServiceItems:
- Index: 0
ID: '123700020001'
Name: test group
Description: 通知先グループの説明
Provider:
Class: saknoticegroup
Settings:
Destinations:
- '123700010001'
- '123700010002'
CreatedAt: '2025-12-18T12:00:00+09:00'
ModifiedAt: '2025-12-18T12:00:00+09:00'
Icon:
ID: '123700100001'
Tags: []
ReadNotificationHistoryResponse:
value:
NotificationHistory:
request_id: '12345'
source_id: ''
statuses:
- id: '67890'
status: 2
error_info: ''
notification_request_id: '12345'
group_id: '123700020001'
destination_id: '123700010001'
created_at: '2025-12-18T12:00:00+09:00'
updated_at: '2025-12-18T12:05:00+09:00'
received_at: '2025-12-18T12:00:00+09:00'
message:
body: This is a test notification message.
color: default
color_code: '#7d7d7d'
icon_url: https://example.com/icon.png
image_url: https://example.com/image.png
title: Test Notification
ListNotificationHistoriesResponse:
value:
NotificationHistories:
- request_id: '12345'
source_id: ''
statuses:
- id: '67890'
status: 2
error_info: ''
notification_request_id: '12345'
group_id: '123700020001'
destination_id: '123700010001'
created_at: '2025-12-18T12:00:00+09:00'
updated_at: '2025-12-18T12:05:00+09:00'
received_at: '2025-12-18T12:00:00+09:00'
message:
body: This is a test notification message.
color: default
color_code: '#7d7d7d'
icon_url: https://example.com/icon.png
image_url: https://example.com/image.png
title: Test Notification
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: "[クラウドコントロールパネル](https://secure.sakura.ad.jp/cloud/)で発行したAPIキーを利用します。\n\n `アクセストークン(UUID)` を「ユーザーID」、`アクセストークンシークレット` を「パスワード」として指定します。"
account_api_key:
type: http
scheme: basic
description: "[クラウドコントロールパネル](https://secure.sakura.ad.jp/cloud/)で発行したAPIキー\n\n `アクセストークン(UUID)` を「ユーザーID」、\n `アクセストークンシークレット` を「パスワード」として指定します"
ApiKeyAuth:
type: http
scheme: basic
description: APIキーを利用したBasic認証
externalDocs:
url: https://manual.sakura.ad.jp/cloud/controlpanel/eventlog/security-control.html
x-refined-from:
- addon-api.yaml
- apigw-api.yaml
- apprun-shared-api.yaml
- monitoring-suite-api.yaml
- networking-suite-api.yaml
- nosql-api.yaml
- objectstorage-api.yaml
- phy-api-original-swagger.json
- security-control-api.yaml
- seg-api.yaml
- simple-notification-api.yaml
- workflows-api.yaml
- sakura-internet-addon-openapi.yml
- sakura-internet-apigw-openapi.yml
- sakura-internet-apprun-shared-openapi.yml
- sakura-internet-monitoring-suite-openapi.yml
- sakura-internet-networking-suite-openapi.yml
- sakura-internet-nosql-openapi.yml
- sakura-internet-objectstorage-openapi.yml
- sakura-internet-phy-openapi.yml
- sakura-internet-security-control-openapi.yml
- sakura-internet-seg-openapi.yml
- sakura-internet-simple-notification-openapi.yml
- sakura-internet-workflows-openapi.yml