Skip to content

paths.md

Latest commit

 

History

History
4286 lines (2634 loc) · 80.9 KB

paths.md

File metadata and controls

4286 lines (2634 loc) · 80.9 KB

Resources

Access-entry-controller

Access Entry Controller

createAccessEntry

POST /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body accessEntryDTO
required		 accessEntryDTO AccessEntryDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AccessEntryDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

pageList

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AccessEntryDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

checkAccessEntryNameUnique

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/check-name
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query id
optional		 id integer(int64)
Query name
required		 name string
Responses
HTTP Code Description Schema
200 OK ResponseObject«boolean»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

ids

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/ids
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query ids
required		 ids < integer(int64) > array(multi)
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AccessEntryDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getUniquePort

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/ports
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«long»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

get

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/{accessId}
Parameters
Type Name Description Schema
Path accessId
required		 accessId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AccessEntryDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

update

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/{accessId}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path accessId
required		 accessId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body accessEntryDTO
required		 accessEntryDTO AccessEntryDTO
Responses
HTTP Code Description Schema
200 OK object
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

delete

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/{accessId}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path accessId
required		 accessId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AccessEntryDTO»
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

bind

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/{accessId}/bind/{servicePortId}
Parameters
Type Name Description Schema
Path accessId
required		 accessId integer(int64)
Path namespace
required		 namespace string
Path servicePortId
required		 servicePortId integer(int64)
Path tenantId
required		 tenantId string
Body accessEntryDTO
required		 accessEntryDTO AccessEntryDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AccessEntryDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

unbind

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/accesses/{accessId}/unbind
Parameters
Type Name Description Schema
Path accessId
required		 accessId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AccessEntryDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Alarm-record-admin-controller

Alarm Record Admin Controller

createAlarmRecord

POST /api/v1/admin/alarm-records
Responses
HTTP Code Description Schema
200 OK No Content
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

list

GET /api/v1/admin/alarm-records
Parameters
Type Name Description Schema
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AlarmRecordDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Alarm-record-controller

Alarm Record Controller

list

GET /api/v1/tenants/{tenantId}/alarm-records
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AlarmRecordDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Alarm-strategy-controller

Alarm Strategy Controller

create

POST /api/v1/tenants/{tenantId}/alarm-strategies
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path tenantId
required		 tenantId string
Body alarmStrategy
required		 alarmStrategy AlarmStrategyDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AlarmStrategyDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

list

GET /api/v1/tenants/{tenantId}/alarm-strategies
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AlarmStrategyItemDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

validateAlarmStrategyName

GET /api/v1/tenants/{tenantId}/alarm-strategies/duplication-name
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Query name
required		 name string
Query oid
optional		 oid integer(int64)
Responses
HTTP Code Description Schema
200 OK ResponseObject«boolean»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

deleteAlarmStrategy

DELETE /api/v1/tenants/{tenantId}/alarm-strategies/{alarmStrategyId}
Parameters
Type Name Description Schema
Path alarmStrategyId
required		 alarmStrategyId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK object
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

get

GET /api/v1/tenants/{tenantId}/alarm-strategies/{id}
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AlarmStrategyDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

update

PUT /api/v1/tenants/{tenantId}/alarm-strategies/{id}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Body alarmStrategyNameDTO
required		 alarmStrategyNameDTO AlarmStrategyNameDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AlarmStrategyDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

updateAlarmRuleList

PUT /api/v1/tenants/{tenantId}/alarm-strategies/{id}/alarm-rules
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Body alarmRuleListDTO
required		 alarmRuleListDTO AlarmRuleListDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AlarmRuleDTO»»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAlarmNotificationUserList

GET /api/v1/tenants/{tenantId}/alarm-strategies/{id}/notification-user-list
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AlarmNotificationUserDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

updateNotificationUsersList

PUT /api/v1/tenants/{tenantId}/alarm-strategies/{id}/notification-users
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Body alarmNotificationUserListDTO
required		 alarmNotificationUserListDTO AlarmNotificationUserListDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AlarmNotificationUserDTO»»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAlarmResourceBindingList

GET /api/v1/tenants/{tenantId}/alarm-strategies/{id}/resource-binding-list
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AlarmResourceBindingDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

updateAlarmResourceBindingsList

PUT /api/v1/tenants/{tenantId}/alarm-strategies/{id}/resource-bindings
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Body alarmResourceBindingListDTO
required		 alarmResourceBindingListDTO AlarmResourceBindingListDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AlarmResourceBindingDTO»»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAlarmRuleList

GET /api/v1/tenants/{tenantId}/alarm-strategies/{id}/rule-list
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AlarmRuleDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

App-blue-green-upgrade-controller

App Blue Green Upgrade Controller

blueGreenUpgradeApplication

POST /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{currentAppId}/blue-green-upgrade
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path currentAppId
required		 currentAppId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body buBlueGreenDeployDTO
required		 buBlueGreenDeployDTO BlueGreenDeployDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

App-blue-green-upgrade-task-controller

App Blue Green Upgrade Task Controller

pageList

GET /api/v1/tenants/{tenantId}/app-blue-green-upgrade-tasks
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppBlueGreenUpgradeTaskDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

finishedBlueGreenUpgrade

POST /api/v1/tenants/{tenantId}/app-blue-green-upgrade-tasks/{id}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppBlueGreenUpgradeTaskDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

get

GET /api/v1/tenants/{tenantId}/app-blue-green-upgrade-tasks/{id}
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppBlueGreenUpgradeTaskDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

cancelBlueGreenUpgrade

DELETE /api/v1/tenants/{tenantId}/app-blue-green-upgrade-tasks/{id}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppBlueGreenUpgradeTaskDTO»
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

toggleDefaultAccessApp

PUT /api/v1/tenants/{tenantId}/app-blue-green-upgrade-tasks/{id}/{defaultAccessAppId}
Parameters
Type Name Description Schema
Header userId
required		 userId string
Path defaultAccessAppId
required		 defaultAccessAppId integer(int64)
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Application-admin-controller

Application Admin Controller

list

GET /api/v1/admin/apps
Parameters
Type Name Description Schema
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppStatisticByNamespace

GET /api/v1/admin/apps/namespace-statistics
Parameters
Type Name Description Schema
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppStatisticDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppQuantityStatisticList

GET /api/v1/admin/apps/quantity
Parameters
Type Name Description Schema
Query namespace
optional		 namespace string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AllQuantityStatisticDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppStatusList

GET /api/v1/admin/apps/status-list
Parameters
Type Name Description Schema
Query namespace
optional		 namespace string
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AppStatusDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppStatisticByTenant

GET /api/v1/admin/apps/tenant-statistics
Parameters
Type Name Description Schema
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppStatisticDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

get

GET /api/v1/admin/apps/{appId}
Parameters
Type Name Description Schema
Path appId
required		 appId integer(int64)
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

update

PUT /api/v1/admin/apps/{appId}
Parameters
Type Name Description Schema
Path appId
required		 appId integer(int64)
Body appDTO
required		 appDTO AppDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Application-controller

Operations about apps

list

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

checkNamespaceName

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/duplication-name
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query appId
optional		 appId integer(int64)
Query appName
required		 appName string
Responses
HTTP Code Description Schema
200 OK ResponseObject«boolean»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Find app by appId

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}
Description

Returns a app when ID < 10. ID > 10 or nonintegers will simulate API error conditions

Parameters
Type Name Description Schema
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseEntity
400 Invalid appId supplied No Content
401 Unauthorized No Content
403 Forbidden No Content
404 App not found No Content
Consumes
  • application/json
Produces
  • */*

update

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}
Parameters
Type Name Description Schema
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body appDTO
required		 appDTO AppDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

cancelTop

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}/cancel-top
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

redeploy

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}/redeploy
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

services

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}/services
Parameters
Type Name Description Schema
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ServiceDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

start

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}/start
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

stop

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}/stop
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

top

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{appId}/top
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path appId
required		 appId integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

deleteApplication

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespace}/apps/{id}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

Application-create-controller

Application Create Controller

createApplication

POST /api/v1/tenants/{tenantId}/apps
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path tenantId
required		 tenantId string
Body appDTO
required		 appDTO AppDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«AppDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Application-statistics-controller

Application Statistics Controller

blueprintAppAndPodStatistics

GET /api/v1/tenants/{tenantId}/apps/blueprint-statistics
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«BlueprintAppStatisticsDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getBuleprintVersionAppServicePodCpuMemCount

GET /api/v1/tenants/{tenantId}/apps/blueprint-version-statistics
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«BlueprintVersionAppStatisticsDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppStatisticByNamespace

GET /api/v1/tenants/{tenantId}/apps/namespace-statistics
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppStatisticDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppQuantityStatisticList

GET /api/v1/tenants/{tenantId}/apps/quantity
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Query namespace
optional		 namespace string
Responses
HTTP Code Description Schema
200 OK ResponseObject«AllQuantityStatisticDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppStatusList

GET /api/v1/tenants/{tenantId}/apps/status-list
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Query namespace
optional		 namespace string
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«AppStatusDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAppStatisticByTenant

GET /api/v1/tenants/{tenantId}/apps/tenant-statistics
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«AppStatisticDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Config-file-controller

Config File Controller

create

POST /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-files
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body configFileDTO
required		 configFileDTO ConfigFileDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ConfigFileDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

validateDuplicateConfigFileName

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-files/validate/{configGroupOid}
Parameters
Type Name Description Schema
Path configGroupOid
required		 configGroupOid integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query name
required		 name string
Responses
HTTP Code Description Schema
200 OK ResponseObject«boolean»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

update

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-files/{configFileOid}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path configFileOid
required		 configFileOid integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body configFileDTO
required		 configFileDTO ConfigFileDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ConfigFileDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

delete

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-files/{configFileOid}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path configFileOid
required		 configFileOid integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ConfigFileDTO»
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

list

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-files/{configGroupOid}
Parameters
Type Name Description Schema
Path configGroupOid
required		 configGroupOid string
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ConfigFileDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Config-group-controller

Config Group Controller

create

POST /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body configGroupDTO
required		 configGroupDTO ConfigGroupDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ConfigGroupDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

list

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ConfigGroupDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

validateDuplicateConfigGroupName

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups/duplication-name
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query name
required		 name string
Query oid
optional		 oid string
Responses
HTTP Code Description Schema
200 OK ResponseObject«boolean»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

listConfigGroup

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups/list
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ConfigGroupDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

listConfigFilesByServiceIds

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups/services
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query serviceIds
required		 serviceIds < integer(int64) > array(multi)
Responses
HTTP Code Description Schema
200 OK ResponseObject«List«ServiceMountConfigDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

update

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups/{configGroupOid}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path configGroupOid
required		 configGroupOid integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body configGroupDTO
required		 configGroupDTO ConfigGroupDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ConfigGroupDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

delete

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups/{configGroupOid}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path configGroupOid
required		 configGroupOid integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ConfigGroupDTO»
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

listConfigFilesByServiceId

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/config-groups/{serviceId}
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceMountConfigDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Config-group-unbind-blueprint-controller

Config Group Unbind Blueprint Controller

unbind

PUT /api/v1/tenants/{tenantId}/config-groups
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body blueprintVersionList
required		 blueprintVersionList < BlueprintVersionItem > array
Responses
HTTP Code Description Schema
200 OK ResponseList«ConfigGroupDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Pod-configuration-admin-controller

Pod Configuration Admin Controller

getPodConfiguration

POST /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getPodConfiguration

GET /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getPodConfiguration

PUT /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getPodConfiguration

DELETE /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

getPodConfiguration

PATCH /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

getPodConfiguration

HEAD /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

getPodConfiguration

OPTIONS /api/v1/admin/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Responses
HTTP Code Description Schema
200 OK object
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

Pod-configuration-controller

Pod Configuration Controller

getPodConfiguration

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/{id}/configuration
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK object
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Pod-controller

Pod Controller

listPod

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body query
optional		 query Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«PodListDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getIstioSystemUsedInfo

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/istio-system-used-info
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK object
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getPodInfo

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/{podId}
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path podId
required		 podId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK object
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

rebuild

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/{podId}/rebuild
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path podId
required		 podId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«PodDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Pod-logging-admin-controller

Pod Logging Admin Controller

getPodLog

GET /api/v1/admin/pods/{id}/logging
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Query podId
optional		 integer(int64)
Query podNameSpace
optional		 string
Query uuId
optional		 string
Responses
HTTP Code Description Schema
200 OK SseEmitter
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Pod-logging-controller

Pod Logging Controller

getPodLog

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/{id}/logging
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query podId
optional		 integer(int64)
Query podNameSpace
optional		 string
Query uuId
optional		 string
Responses
HTTP Code Description Schema
200 OK SseEmitter
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

heartbeat

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/{id}/logging/heartbeat
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query podId
required		 podId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«string»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Pod-process-admin-controller

Pod Process Admin Controller

createPodProcessDetailWatcher

GET /api/v1/admin/pods/{id}/process
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path tenantId
required		 tenantId string
Query namespace
required		 namespace string
Responses
HTTP Code Description Schema
200 OK object
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Pod-process-controller

Pod Process Controller

createPodProcessDetailWatcher

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/pods/{id}/process
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK object
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Resource-statistics-admin-controller

Resource Statistics Admin Controller

getResourceStatistics

GET /api/v1/admin/resources
Parameters
Type Name Description Schema
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseObject«ResourceStatisticsDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Service-admin-controller

Service Admin Controller

list

GET /api/v1/admin/services
Parameters
Type Name Description Schema
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ServiceDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Service-controller

Service Controller

list

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ServiceDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getAccessStatistics

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/access-statistics
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseObject«Map«long,ServiceDTO»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

checkServiceNameUnique

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/duplication-name
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Query serviceName
required		 serviceName string
Responses
HTTP Code Description Schema
200 OK ResponseObject«boolean»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getVolumeStatistics

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/volume-statistics
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseObject«Map«long,List«long»»»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

get

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

getNetworkSecurity

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}/network-security
Parameters
Type Name Description Schema
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«NetworkSecurityDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

createNetworkSecurity

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}/network-security
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body networkSecurity
required		 networkSecurity NetworkSecurityDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

redeploy

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}/redeploy
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

scaleOut

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}/scale-out
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body dto
required		 dto ServiceScaleOutActionDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

start

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}/start
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

stop

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{id}/stop
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path id
required		 id integer(int64)
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

postAutoAcale

POST /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/auto-scale
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Body serviceAutoScaleDTO
required		 serviceAutoScaleDTO ServiceAutoScaleDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceAutoScaleDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

putAutoAcale

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/auto-scale
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Body serviceAutoScaleDTO
required		 serviceAutoScaleDTO ServiceAutoScaleDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceAutoScaleDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

autoAcaleStop

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/auto-scale
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceAutoScaleDTO»
204 No Content No Content
401 Unauthorized No Content
403 Forbidden No Content
Consumes
  • application/json
Produces
  • */*

getAutoAcale

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/auto-scale/{autoScaleId}
Parameters
Type Name Description Schema
Path autoScaleId
required		 autoScaleId integer(int64)
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceAutoScaleDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

greyUpgrade

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/gated-launch
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Body serviceDTO
required		 serviceDTO ServiceDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

rollingUpgrade

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/rolling-upgrade
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Body service
required		 service ServiceDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

scaleUp

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/services/{serviceId}/scale-up
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path serviceId
required		 serviceId integer(int64)
Path tenantId
required		 tenantId string
Body scaleUp
required		 scaleUp ServiceScaleUpDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Service-gray-upgrade-controller

Service Gray Upgrade Controller

serviceUpgradeByCondition

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/service-gray-upgrade-tasks
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseEntity
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

serviceUpgradeById

GET /api/v1/tenants/{tenantId}/namespaces/{namespace}/service-gray-upgrade-tasks/{serviceUpgradeId}
Parameters
Type Name Description Schema
Path namespace
required		 namespace string
Path serviceUpgradeId
required		 serviceUpgradeId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseEntity
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

updateUpgradeConfig

PUT /api/v1/tenants/{tenantId}/namespaces/{namespace}/service-gray-upgrade-tasks/{serviceUpgradeId}
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path namespace
required		 namespace string
Path serviceUpgradeId
required		 serviceUpgradeId integer(int64)
Path tenantId
required		 tenantId string
Body configData
required		 configData ServiceGrayUpgradeConfigDTO
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceGrayUpgradeTaskDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Service-grey-upgrade-action-controller

Service Grey Upgrade Action Controller

grayScaleToUpgradeCancel

PUT /api/v1/tenants/{tenantId}/services/gated-launch/{launchId}/cancel
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path launchId
required		 launchId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceGrayUpgradeTaskDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

grayScaleToUpgradeFinish

PUT /api/v1/tenants/{tenantId}/services/gated-launch/{launchId}/finish
Parameters
Type Name Description Schema
Header userId
optional		 userId string
Path launchId
required		 launchId integer(int64)
Path tenantId
required		 tenantId string
Responses
HTTP Code Description Schema
200 OK ResponseObject«ServiceGrayUpgradeTaskDTO»
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Service-statistics-controller

Service Statistics Controller

getServiceUsageTop5

GET /api/v1/tenants/{tenantId}/services/usage
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseList«ServiceUsageDTO»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*

Volume-monitor-controller

Volume Monitor Controller

rangeQuery

GET /api/v1/tenants/{tenantId}/volumes/{volumeId}/monitor/series
Parameters
Type Name Description Schema
Path tenantId
required		 tenantId string
Path volumeId
required		 volumeId integer(int64)
Body metadata
optional		 metadata Metadata
Responses
HTTP Code Description Schema
200 OK ResponseObject«MonitorResult»
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content
Consumes
  • application/json
Produces
  • */*