swagger: '2.0'
info:
version: v1
title: Fleet Manager
description: 应用进程队列管理
host: scase.myhuaweicloud.com
schemes:
- https
basePath: /v1
produces:
- application/json
consumes:
- application/json; charset=UTF-8
tags:
- name: 应用进程队列管理
- name: 应用进程队列运行状态查询
- name: 伸缩策略管理
- name: 服务器会话管理
- name: 客户端会话管理
- name: 应用进程管理
- name: 别名管理
- name: 应用包管理
- name: 用户管理
- name: 日志管理
- name: 其他资源管理
- name: 首页
- name: 实例规格管理
- name: 事件审计
- name: 资源监控
parameters:
Auth-token:
name: Auth-token
in: header
type: string
description: |
用户Token。
通过用户登录后的请求体中获取,请求API需要在请求头中带此参数
required: true
minLength: 1
maxLength: 16384
contentType:
name: Content-Type
in: header
required: true
type: string
minLength: 1
maxLength: 64
description: |
MIME类型;带请求体的请求该字段需为 application/json;charset=utf-8
projectId:
name: project_id
in: path
type: string
description: |
项目ID,获取方法请参考[获取项目ID]()
required: true
minLength: 1
maxLength: 64
fleetId:
name: fleet_id
in: path
description: 应用进程队列的id,由创建应用进程队列接口返回,格式为uuid,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
required: true
type: string
minLength: 1
maxLength: 64
aliasId:
name: alias_id
in: path
description: 应用进程队列别名的id,由创建应用进程队列接口返回,格式为uuid,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
required: true
type: string
minLength: 1
maxLength: 64
offset:
name: offset
in: query
required: false
type: integer
format: int32
minimum: 0
maximum: 10
default: 0
description: 分页偏移量,为0表示第一页,为1表示从第二页开始显示
limit:
name: limit
in: query
required: false
type: integer
format: int32
minimum: 1
maximum: 100
default: 100
description: 单页显示的数据条数
serverSessionId:
name: server_session_id
in: path
required: true
type: string
description: 服务器会话id,通过创建服务器会话接口返回,全局唯一,uuid格式,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
clientSessionId:
name: client_session_id
in: path
required: true
type: string
description: 客户端会话id,通过创建客户端会话接口返回,全局唯一,uuid格式,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
instanceId:
name: instance_id
in: query
description: 每一个实例id,由ECS服务自动生成,全局唯一,uuid格式,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
required: false
type: string
minLength: 1
maxLength: 64
durationStart:
name: duration_start
in: query
required: false
type: integer
format: int32
description: 筛选当前在应用进程队列/实例/进程上的会话最小数量,默认不设置
durationEnd:
name: duration_end
in: query
required: false
type: integer
format: int32
description: 筛选当前在应用进程队列/实例/进程上的会话最大数量,默认不设置
ipAddress:
name: ip_address
in: query
required: false
type: string
description: 筛选的ip地址,如100.20.13.25
processId:
name: process_id
in: query
required: false
type: string
description: 进程id,全局唯一,uuid格式,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
startTime:
name: start_time
in: query
required: false
type: string
description: 筛选的数据的开始时间,例如:2022-12-01T20:37:39
minLength: 1
maxLength: 64
endTime:
name: end_time
in: query
required: false
type: string
description: 筛选的数据的结束时间,例如:2022-12-01T20:37:39
minLength: 1
maxLength: 64
Userid:
name: id
in: query
required: false
description: 用户id
type: string
ResouarceId:
name: id
in: query
required: false
description: 资源配置id,全局唯一,uuid格式,例如c0544f73-bce0-11ed-991f-fa163ecd2502
type: string
eventId:
name: event_id
in: path
required: true
description: 事件id,全局唯一,uuid格式,例如c0544f73-bce0-11ed-991f-fa163ecd2502
type: string
paths:
/{project_id}/fleets:
post:
tags:
- 应用进程队列管理
operationId: CreateFleet
summary: 创建应用进程队列
description: 创建应用进程队列
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- in: body
name: CreateFleetRequestBody
description: 创建应用进程队列请求体
required: true
schema:
$ref: '#/definitions/CreateFleetRequestBody'
responses:
'201':
description: 创建成功响应
schema:
$ref: '#/definitions/CreateFleetResponseBody'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 0
get:
tags:
- 应用进程队列管理
operationId: ListFleets
summary: 查询应用进程队列列表
description: 查询应用进程队列列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'200':
description: 应用进程队列列表
schema:
$ref: '#/definitions/ListFleetsResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 2
/{project_id}/fleets/{fleet_id}:
delete:
tags:
- 应用进程队列管理
operationId: DeleteFleet
summary: 删除应用进程队列
description: 删除前请确认该fleet是否关联有alias,若关联,则无法被删除
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
responses:
'204':
description: 删除应用进程队列成功
schema:
type: string
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 4
get:
tags:
- 应用进程队列管理
operationId: ShowFleet
summary: 查询应用队列基本信息
description: 查询应用队列基本信息
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
responses:
'200':
description: 查询应用进程队列详情响应
schema:
$ref: '#/definitions/ShowFleetResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 5
put:
tags:
- 应用进程队列管理
operationId: UpdateFleet
summary: 更新应用队列基本信息
description: 更新应用队列基本信息
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- in: body
name: UpdateFleetRequestBody
description: Fleet object that needs to be modified
required: true
schema:
$ref: '#/definitions/UpdateFleetAttributesReuqestBody'
responses:
'204':
description: 更新应用队列基本信息成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 6
/{project_id}/fleets/{fleet_id}/inbound-permissions:
get:
tags:
- 应用进程队列管理
operationId: ShowFleetInboundPermissions
summary: 查询应用队列入站规则
description: 查询应用队列入站规则
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
responses:
'200':
description: 应用进程队列安全组信息
schema:
$ref: '#/definitions/ShowInboundPermissionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 7
put:
tags:
- 应用进程队列管理
operationId: UpdateFleetInboundPermissions
summary: 更新应用队列入站规则
description: 更新应用队列入站规则
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- in: body
name: UpdateFleetInboundPermissionsRequestBody
description: Fleet object that needs to be modified
required: true
schema:
$ref: '#/definitions/UpdateFleetInboundPermissionsRequestBody'
responses:
'204':
description: 更新应用进程队列安全组成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 8
/{project_id}/fleets/{fleet_id}/runtime-configuration:
get:
tags:
- 应用进程队列管理
operationId: ShowFleetRuntimeConfiguration
summary: 查询应用队列运行配置
description: 查询应用队列运行配置
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
responses:
'200':
description: 应用进程队列运行配置详情
schema:
$ref: '#/definitions/FleetRuntimeConfigurationResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 9
put:
tags:
- 应用进程队列管理
operationId: UpdateFleetRuntimeConfiguration
summary: 更新应用队列运行配置
description: 更新应用队列运行配置
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- in: body
name: UpdateFleetRuntimeConfigurationRequestBody
description: Fleet object that needs to be modified
required: true
schema:
$ref: '#/definitions/RuntimeConfiguration'
responses:
'204':
description: 更新应用进程队列运行配置成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 10
/{project_id}/fleets/{fleet_id}/instance-capacity:
get:
tags:
- 应用进程队列管理
summary: 获取应用进程队列的容量信息
description: 获取应用进程队列的容量信息
operationId: ShowFleetInstanceCapacity
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
responses:
'200':
description: 应用进程队列实例容量信息
schema:
$ref: '#/definitions/ShowFleetCapacityResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 11
put:
tags:
- 应用进程队列管理
operationId: UpdateFleetInstanceCapacity
summary: 更新应用队列容量
description: 更新应用队列容量
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- in: body
name: UpdateFleetInstanceCapacityRequestBody
description: Fleet object that needs to be modified
required: true
schema:
$ref: '#/definitions/UpdateFleetInstanceCapacityRequestBody'
responses:
'204':
description: 更新应用进程队列实例容量成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 12
/{project_id}/fleets/{fleet_id}/process-counts:
get:
tags:
- 应用进程队列管理
summary: 获取处于不同状态的应用进程数量信息
description: 获取处于不同状态的应用进程数量信息
operationId: ListFleetProcesses
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
responses:
'200':
description: 应用进程队列处于不同状态的进程数量信息
schema:
$ref: '#/definitions/ProcessCountsResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 13
/{project_id}/server-sessions:
post:
tags:
- 服务器会话管理
summary: 创建服务器会话
description: 创建服务器会话,可以选择根据fleet_id或alias_id创建会话,两者不能同时配置
operationId: CreateServerSession
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- name: CreateServerSessionRequestBody
in: body
description: 创建服务器请求体
required: true
schema:
$ref: '#/definitions/CreateServerSessionRequestBody'
responses:
'201':
description: 创建服务会话成功响应
schema:
$ref: '#/definitions/CreateServerSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
get:
tags:
- 服务器会话管理
summary: 获取服务器会话列表
description: 获取服务器会话列表
operationId: ListServerSessions
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- name: fleet_id
in: query
description: >-
应用进程队列的id,由创建应用进程队列接口返回,格式为uuid,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
required: true
type: string
minLength: 1
maxLength: 64
- name: state
in: query
required: false
description: |
根据服务器会话的状态进行过滤。
* ACTIVE: 活跃
* ACTIVATING: 激活中
* TERMINATED: 终止
* TERMINATING: 终止中
* ERROR: 异常
type: string
enum:
- ACTIVE
- ACTIVATING
- TERMINATED
- TERMINATING
- ERROR
responses:
'200':
description: 服务器会话详情列表
schema:
$ref: '#/definitions/ListServerSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/server-sessions/{server_session_id}:
get:
tags:
- 服务器会话管理
operationId: ShowSession
summary: 获取服务器会话详情
description: 获取服务器会话详情
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/serverSessionId'
responses:
'200':
description: 服务器会话详情
schema:
$ref: '#/definitions/ShowServerSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
put:
tags:
- 服务器会话管理
summary: 更新服务器会话
description: 更新服务器会话
operationId: UpdateServerSession
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/serverSessionId'
- name: UpdateServerSessionRequestBody
in: body
description: 更新服务器会话请求体
required: false
schema:
$ref: '#/definitions/UpdateServerSessionRequestBody'
responses:
'204':
description: 更新服务器会话成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/server-sessions/{server_session_id}/client-sessions:
post:
tags:
- 客户端会话管理
summary: 创建客户端会话
description: 创建客户端会话
operationId: CreateClientSession
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/serverSessionId'
- name: CreateClientSessionRequestBody
in: body
description: 创建客户端会话请求体
required: true
schema:
$ref: '#/definitions/CreateClientSessionRequestBody'
responses:
'201':
description: 创建客户端会话成功响应
schema:
$ref: '#/definitions/CreateClientSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
get:
tags:
- 客户端会话管理
summary: 获取客户端会话列表
description: 获取客户端会话列表
operationId: ListClientSessions
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/serverSessionId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'200':
description: 客户端会话详情列表
schema:
$ref: '#/definitions/ListClientSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/server-sessions/{server_session_id}/client-sessions/batch-create:
post:
tags:
- 客户端会话管理
summary: 批量创建客户端会话
description: 批量创建客户端会话
operationId: BatchCreateClientSessions
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/serverSessionId'
- name: BatchCreateClientSessionsRequestBody
in: body
description: 创建客户端会话请求体
required: true
schema:
$ref: '#/definitions/BatchCreateClientSessionRequestBody'
responses:
'201':
description: 批量创建客户端会话成功响应
schema:
$ref: '#/definitions/BatchCreateClientSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/server-sessions/{server_session_id}/client-sessions/{client_session_id}:
get:
tags:
- 客户端会话管理
operationId: ShowClientSession
summary: 获取客户端会话详情
description: 获取客户端会话详情
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/serverSessionId'
- $ref: '#/parameters/clientSessionId'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 客户端会话详情列表
schema:
$ref: '#/definitions/ShowClientSessionResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/monitor-fleets:
get:
tags:
- 应用进程队列运行状态查询
summary: 获取应用进程运行状态列表
description: 获取应用进程运行状态列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
operationId: ListMonitorFleets
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/Auth-token'
- name: state
in: query
required: false
description: 应用进程队列状态 枚举:CREATING ACTIVE DELETING ERROR,精准搜索
type: string
- name: fleet_id
in: query
required: false
type: string
description: 应用进程队列id,模糊搜索
- name: fleet_name
in: query
required: false
type: string
description: 应用进程队列名称,模糊搜索
responses:
'200':
description: 响应应用进程队列列表
schema:
$ref: '#/definitions/ListMonitorFleetsResponseBody'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/monitor-fleets/{fleet_id}:
get:
tags:
- 应用进程队列运行状态查询
summary: 获取单个应用进程队列运行状态详情
description: 获取单个应用进程队列运行状态详情
x-is-registered: 'Y'
x-support-sdk: 'Y'
operationId: ShowMonitorFleet
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/fleetId'
responses:
'200':
description: 查询应用进程队列详情响应
schema:
$ref: '#/definitions/ShowMonitorFleetResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/fleets/{fleet_id}/monitor-instances:
get:
tags:
- 应用进程队列运行状态查询
summary: 获取单个应用进程队列中的实例列表
description: 获取单个应用进程队列中的实例列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
operationId: ListMonitorInstances
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/fleetId'
- $ref: '#/parameters/instanceId'
- name: health_state
in: query
required: false
description: >-
实例的健康状态
* Error:异常状态
* Active: >
正常状态
*Activing:初始化
type: string
minLength: 1
maxLength: 64
enum:
- ERROR
- NORMAL
- INITAILIZING
- $ref: '#/parameters/durationStart'
- $ref: '#/parameters/durationEnd'
responses:
'200':
description: 响应实例信息
schema:
$ref: '#/definitions/ListMonitorInstancesResponceBody'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/fleets/{fleet_id}/monitor-app-processes:
get:
tags:
- 应用进程队列运行状态查询
summary: 获取单个应用进程队列中的进程列表
description: 获取单个应用进程队列中的进程列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
operationId: ListMonitorAppProcesses
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/fleetId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/instanceId'
- $ref: '#/parameters/processId'
- $ref: '#/parameters/ipAddress'
- $ref: '#/parameters/durationStart'
- $ref: '#/parameters/durationEnd'
- name: state
in: query
required: false
description: |
* ACTIVATING: 进程正在激活
* ERROR: 进程异常
* ACTIVE: 进程已被激活
* TERMINATED: 进程已被终止
* TERMINATING: 进程正在被终止
type: string
minLength: 1
maxLength: 64
enum:
- ACTIVATING
- ERROR
- ACTIVE
- TERMINATED
- TERMINATING
responses:
'200':
description: 响应进程信息
schema:
$ref: '#/definitions/ListMonitorAppProcessResponceBody'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/fleets/{fleet_id}/monitor-server-sessions:
get:
tags:
- 应用进程队列运行状态查询
summary: 获取单个应用进程队列中会话列表
description: 获取单个应用进程队列中的会话列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
operationId: ListMonitorServerSessions
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/fleetId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/instanceId'
- $ref: '#/parameters/processId'
- $ref: '#/parameters/ipAddress'
- $ref: '#/parameters/startTime'
- $ref: '#/parameters/endTime'
- name: state
in: query
required: false
description: |
* ACTIVATING: 会话正在激活
* ERROR: 会话异常
* ACTIVE: 会话已被激活
* TERMINATED: 会话已被终止
type: string
minLength: 1
maxLength: 64
enum:
- ACTIVATING
- ERROR
- ACTIVE
- TERMINATED
- name: server_session_id
in: query
required: false
type: string
description: 服务器会话id,通过创建服务器会话接口返回,全局唯一,uuid格式,例如:77317ac6-acd8-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
responses:
'200':
description: 响应会话信息
schema:
$ref: '#/definitions/ListMonitorServerSessionResponceBody'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器错误
schema:
$ref: '#/definitions/ErrorRsp'
/v1/{project_id}/app-processes:
get:
tags:
- 应用进程管理
summary: 获取应用进程列表
description: 获取应用进程列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
operationId: ListAppProcess
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- name: fleet_id
in: query
required: true
description: >-
应用进程队列的id,由创建应用进程队列接口返回,格式为fleet-uuid,例如:fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
type: string
minLength: 1
maxLength: 64
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 响应进程列表
schema:
$ref: '#/definitions/ListProcessResponseBody'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/aliases:
post:
tags:
- 别名管理
operationId: CreateAlias
summary: 创建应用进程队列
description: 创建应用进程队列
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- in: body
name: CreateAliasRequestBody
description: 创建应用进程队列别名请求体
required: true
schema:
$ref: '#/definitions/CreateAliasRequestBody'
responses:
'201':
description: 创建成功响应
schema:
$ref: '#/definitions/CreateAliasResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
get:
tags:
- 别名管理
operationId: ListAliases
summary: 获取应用进程队列别名列表
description: 获取应用进程队列别名列表
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- in: query
name: fleet_id
description: 搜索alias所关联的fleet_id
required: false
type: string
minLength: 1
maxLength: 64
- in: query
name: type
description: |-
别名的类型
* ACTIVE: 激活类型,该类型的alias可以指向flee列表t,并且可以使用该alias创建会话
* DEACTIVE: 停用类型,该类型的alias不会指向fleet,使用该alias创建会话会直接返回该结构体中message的信息
* TERMINATED: 表示该Alias已被删除
required: false
type: string
minLength: 1
maxLength: 64
- in: query
name: name
description: 别名的名称,支持模糊搜索
required: false
type: string
minLength: 1
maxLength: 1024
responses:
'200':
description: 应用进程队列列表
schema:
$ref: '#/definitions/ListAliasResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/aliases/{alias_id}:
get:
tags:
- 别名管理
operationId: ShowAlias
summary: 查询应用队列别名基本信息
description: 查询应用队列别名基本信息
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/aliasId'
responses:
'200':
description: 查询应用进程队列别名详情响应
schema:
$ref: '#/definitions/ShowAliasResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
put:
tags:
- 别名管理
operationId: UpdateAlias
summary: 更新应用队列别名基本信息
description: 更新应用队列别名基本信息
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/aliasId'
- in: body
name: UpdateAliasRequestBody
description: Alias object that needs to be modified
required: true
schema:
$ref: '#/definitions/UpdateAliasRequestBody'
responses:
'204':
description: 更新应用队列基本信息成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
delete:
tags:
- 别名管理
operationId: DeleteAlias
summary: 删除应用进程队列
description: Delete Alias by ID
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/aliasId'
responses:
'204':
description: 删除应用进程队列成功
schema:
type: string
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/user/login:
post:
tags:
- 用户管理
summary: 用户登录
description: 用户登录接口
operationId: UserLogin
consumes:
- application/x-www-form-urlencoded
parameters:
- name: LoginParam
in: body
required: false
schema:
$ref: '#/definitions/LoginParam'
responses:
'201':
description: 用户信息解析成功,返回用户相关信息
schema:
$ref: '#/definitions/LoginResponse'
headers:
Auth-Token:
description: 用户认证token,访问API时请求头需携带此参数
type: string
username:
description: 当前登录用户名
type: string
sessionid:
description: 当前登录用户会话id
type: string
ExpireTime:
description: token过期时间
type: string
'400':
description: 请求参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 0
/v1/user/logout:
post:
tags:
- 用户管理
summary: 用户登出
description: 用户登出,删除登录会话
operationId: UserLogout
parameters:
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 登出成功
schema:
type: string
x-order: 1
/user/changepass:
put:
tags:
- 用户管理
summary: 修改密码
description: 用户修改密码
operationId: ChangePassword
consumes:
- application/x-www-form-urlencoded
parameters:
- name: ChangePassBody
in: body
required: false
schema:
$ref: '#/definitions/ChangePassBody'
description: 修改密码结构体
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 密码修改成功,自动登出
schema:
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 2
/admin/resconfig:
post:
tags:
- 用户管理
summary: 管理员为用户新增租户信息
operationId: InsertResConfig
parameters:
- name: ResourceConfig
in: body
required: true
description: 资源租户信息
schema:
$ref: '#/definitions/ResConfig'
- $ref: '#/parameters/Auth-token'
responses:
'201':
description: 请求成功
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 4
delete:
tags:
- 用户管理
summary: 删除用户资源账户信息
description: 根据origin字段与region删除租户
operationId: DeleteResConfig
consumes:
- application/x-www-form-urlencoded
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/ResouarceId'
responses:
'204':
description: 删除成功
schema:
type: string
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 5
put:
tags:
- 用户管理
summary: 修改租户信息
operationId: AdminUpdateResConfig
consumes:
- application/x-www-form-urlencoded
parameters:
- name: ModifyResConfigBody
in: body
required: true
description: 修改租户信息结构体
schema:
$ref: '#/definitions/ModifyResConfigBody'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 修改成功
schema:
type: string
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 6
get:
tags:
- 用户管理
summary: 管理员获取所有租户信息
description: 获取所有租户信息
operationId: AdminGetAllResConfig
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'200':
description: 返回所有租户信息数量和详情
schema:
$ref: '#/definitions/ResConfList'
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/builds/upload:
post:
tags:
- 应用包管理
operationId: UploadBuild
consumes:
- multipart/form-data
summary: 上传应用
description: 上传应用(通过console上传应用)(参数存在form-data中)
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: file
in: formData
required: true
type: string
format: binary
description: 应用包文件 将校验后缀(zip与rar)将校验大小 小于5GB
- name: region
in: formData
required: true
description: 应用包将存入的region
type: string
- name: bucket_name
in: formData
required: true
description: 应用包将存入的桶名
type: string
responses:
'200':
description: 返回应用包OBS存储信息
schema:
$ref: '#/definitions/UploadBuildResponse'
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 0
/admin/alluser:
get:
tags:
- 用户管理
summary: 获取所有用户
description: 管理员获取所有用户信息
operationId: AdminGetAllUser
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'200':
description: 获取用户信息成功后显示所有用户信息
schema:
$ref: '#/definitions/GetAllUserResp'
'500':
description: 服务器内部错误
schema:
type: string
x-order: 7
/admin/userinfo:
put:
tags:
- 用户管理
summary: 管理员修改用户信息
description: 管理员可修改用户的邮箱,电话,激活状态
operationId: AdminModifyUser
consumes:
- application/x-www-form-urlencoded
parameters:
- name: ReviseUser
in: body
required: true
schema:
$ref: '#/definitions/ReviseUser'
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 返回用户信息
schema:
$ref: '#/definitions/UserInfo'
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
post:
tags:
- 用户管理
summary: 管理员新增用户
description: 管理员新增用户
operationId: AddUser
consumes:
- application/x-www-form-urlencoded
parameters:
- name: UserInfo
in: body
required: true
description: 添加用户信息结构体
schema:
$ref: '#/definitions/UserInfo'
- $ref: '#/parameters/Auth-token'
responses:
'201':
description: 用户新增成功
schema:
$ref: '#/definitions/UserInfo'
'400':
description: 用户名已存在或参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 3
delete:
tags:
- 用户管理
summary: 管理员删除用户
operationId: AdminDeleteUser
parameters:
- $ref: '#/parameters/Userid'
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 删除成功
schema:
type: string
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/user/origininfo:
get:
tags:
- 用户管理
operationId: ListOrigins
summary: 查询使用租户详情信息
description: 查询使用租户详情信息
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: region
in: query
description: 在某个region下origin信息
required: false
type: string
minLength: 0
maxLength: 36
responses:
'200':
description: 查询应用进程队列详情响应
schema:
$ref: '#/definitions/ListOriginInfoResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/user/support-regions:
get:
tags:
- 用户管理
operationId: ListOSupportRegions
summary: 查询支持的region
description: 查询支持的region
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 查询应用进程队列详情响应
schema:
$ref: '#/definitions/ListSupportRegions'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/bandwidths:
get:
tags:
- 其他资源管理
summary: 获取共享带宽列表
description: 获取当前资源账号下的共享带宽列表
operationId: Bandwidths
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- name: share_type
in: query
required: false
type: string
enum:
- PRE
- WHOLE
default: PRE
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ListBandwidthsResp'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/user/bucket:
get:
tags:
- 其他资源管理
summary: 获取当前资源账号指定region 桶名列表
description: 获取当前资源账号指定region 桶名列表
operationId: UserBucket
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserBucketResponse'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 7
/user/userinfo:
get:
tags:
- 用户管理
summary: 获取用户基本信息
description: 获取用户基本信息
operationId: UserInfo
parameters:
- $ref: '#/parameters/Userid'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 返回用户信息
schema:
$ref: '#/definitions/GetUserInfo'
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
put:
tags:
- 用户管理
summary: 用户修改用户信息
operationId: UserReviseInfo
parameters:
- name: UserReviseInfoBody
in: body
required: true
description: 用户只能修改邮箱和电话
schema:
$ref: '#/definitions/UserReviseInfoBody'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 修改成功
schema:
$ref: '#/definitions/GetUserInfo'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/user/resconfig:
get:
tags:
- 用户管理
summary: 用户获取租户信息
description: 用户能获取拥有的所有租户资源信息
operationId: UserGetResConf
parameters:
- $ref: '#/parameters/Auth-token'
- name: id
in: query
required: false
description: 查询指定用户的用户id
type: string
responses:
'200':
description: 获取租户信息成功
schema:
$ref: '#/definitions/ResConfList'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/admin/resetpw:
post:
tags:
- 用户管理
summary: 管理员重置用户密码
operationId: AdminResetPassword
parameters:
- $ref: '#/parameters/Userid'
- $ref: '#/parameters/Auth-token'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/user/image:
get:
tags:
- 其他资源管理
summary: 获取当前资源账号指定region镜像列表
description: 获取当前资源账号指定region 镜像列表
operationId: UserImage
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserImageResponse'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 7
/{project_id}/image-builds:
post:
tags:
- 应用包管理
operationId: CreateBuildByImage
summary: 创建应用--直接绑定镜像
description: 创建应用--直接绑定镜像 注:通过直接绑定镜像创建的应用在删除时不会删除绑定的镜像,会直接删除db记录
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: CreateBuildByImageRequest
in: body
required: true
description: 创建应用-直接绑定镜像 请求体
schema:
$ref: '#/definitions/CreateBuildByImageRequest'
responses:
'200':
description: 返回新增的应用包基础信息
schema:
$ref: '#/definitions/Build'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
type: string
x-order: 1
/{project_id}/builds:
get:
tags:
- 应用包管理
operationId: ListBuilds
summary: 查询应用包列表
description: 查询应用包列表
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: offset
in: query
required: false
type: integer
format: int32
minimum: 0
maximum: 10
description: 分页偏移量,为0表示第一页,为1表示从第二页开始显示
- name: limit
in: query
required: false
type: integer
format: int32
minimum: 1
maximum: 100
- name: name
in: query
required: false
type: string
- name: state
in: query
required: false
type: string
description: 枚举 INITIALIZED(初始化) READY(就绪) IMAGE_CREATING(镜像创建中) FAILED(创建失败)
- name: creation_time
in: query
required: false
type: string
description: '起始时间 + "/" + 结束时间 时间格式为时间戳(秒级) 起始缺失时默认为1 结束缺失时默认为当前时间戳。 例: ”1677486100/1677486300“ 或”/1677486300“或”1677486100/“或”/“'
- name: build_type
in: query
required: false
description: VM 或 POD
type: string
responses:
'200':
description: Build列表
schema:
$ref: '#/definitions/ListBuildsResponseBody'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_id-timestamp-hostname
type: string
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_id-timestamp-hostname
type: string
x-order: 2
post:
tags:
- 应用包管理
operationId: CreateBuild
summary: 创建应用--指定路径
description: 创建应用--指定路径
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: CreateBuildRequest
in: body
required: true
description: 创建应用-指定路径 请求体
schema:
$ref: '#/definitions/CreateBuildRequest'
responses:
'200':
description: 返回新增的应用包基础信息
schema:
$ref: '#/definitions/Build'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
type: string
x-order: 3
/{project_id}/builds/{build_id}:
get:
tags:
- 应用包管理
operationId: ShowBuild
summary: 查询应包详情 包含关联的fleet信息
description: 查询应包详情 包含关联的fleet信息
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: build_id
in: path
description: ID of Build
required: true
type: string
minLength: 32
maxLength: 36
responses:
'200':
description: 应用包详情 包含关联的fleet信息
schema:
$ref: '#/definitions/BuildMsg'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
type: string
x-order: 4
put:
tags:
- 应用包管理
operationId: UpdateBuild
summary: 更新应用包
description: 更新应用包 支持更新名称、版本号、描述,其余均不支持更新
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: build_id
in: path
description: ID of Build
required: true
type: string
minLength: 32
maxLength: 36
- name: UpdateBuildRequestBody
in: body
required: true
description: 更新应用包请求体
schema:
$ref: '#/definitions/UpdateBuildRequestBody'
responses:
'200':
description: 成功 空
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
type: string
x-order: 5
delete:
tags:
- 应用包管理
operationId: DeleteBuild
summary: 删除应用包
description: 删除应用包
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: build_id
in: path
description: ID of Build
required: true
type: string
minLength: 32
maxLength: 36
responses:
'204':
description: 成功 空
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: 请求错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: 服务端内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
type: string
x-order: 6
/{project_id}/user/vpc:
get:
tags:
- 其他资源管理
summary: 获取当前资源账号指定region vpc列表
description: 获取当前资源账号指定region vpc列表
operationId: UserVpc
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserVpcResponse'
'500':
description: 服务器内部错误
schema:
type: string
x-order: 7
/{project_id}/user/subnet:
get:
tags:
- 其他资源管理
summary: 获取当前资源账号指定region 子网列表
description: 获取当前资源账号指定region 子网列表
operationId: UserSubnet
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- name: vpc_id
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserSubnetResponse'
'500':
description: 服务器内部错误
schema:
type: string
x-order: 7
/{project_id}/lts-transfer:
delete:
tags:
- 日志管理
summary: 删除日志转储
operationId: DeleteTransfer
parameters:
- $ref: '#/parameters/projectId'
- name: log_transfer_id
in: query
required: true
description: 转储id
type: string
minLength: 32
maxLength: 36
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 删除成功
schema:
type: string
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
post:
tags:
- 日志管理
summary: 创建日志转储
description: 为日志流创建日志转储,定期转储至OBS
operationId: CreateLogTransfer
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: CreateTransfer
in: body
required: false
description: 创建日志转储
schema:
$ref: '#/definitions/CreateTransfer'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CreateTransferResp'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
get:
tags:
- 日志管理
summary: 获取单条转储信息
description: 日志流只能关联一个日志转储,通过日志流id查询对应的日志转储
operationId: QueryTransfer
parameters:
- $ref: '#/parameters/projectId'
- name: log_stream_id
in: query
required: true
description: 日志流id
type: string
minLength: 32
maxLength: 36
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 查询成功返回详情
schema:
$ref: '#/definitions/QureyTransferInfo'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/lts-access-config:
post:
tags:
- 日志管理
summary: 新增日志接入
operationId: CreateAccessConfig
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: LTS_Config
in: body
required: true
schema:
$ref: '#/definitions/CreateAccessConfig'
responses:
'200':
description: 日志接入成功参数
schema:
$ref: '#/definitions/CreateAccessConfigResp'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
delete:
tags:
- 日志管理
summary: 删除日志接入
operationId: DeleteAccessConfig
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: access_config_id
in: query
required: true
description: 日志接入id
type: string
minLength: 32
maxLength: 36
responses:
'204':
description: 删除成功
schema:
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
get:
tags:
- 日志管理
summary: 查询单条日志接入信息
operationId: QueryAccessConfig
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: access_config_id
in: query
required: true
description: 日志接入id
type: string
minLength: 32
maxLength: 36
responses:
'200':
description: 查询成功
schema:
$ref: '#/definitions/CreateAccessConfigResp'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/list-lts-transfer:
get:
tags:
- 日志管理
summary: 列举所有转储
operationId: ListTransfer
parameters:
- $ref: '#/parameters/projectId'
- name: limit
in: query
required: false
description: 查询数目限制
type: integer
format: int32
- name: offset
in: query
required: false
description: 查询游标
type: integer
format: int32
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ListTransferResp'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/list-lts-access-config:
get:
tags:
- 日志管理
summary: 列举所有日志接入
operationId: ListAccessConfig
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: limit
in: query
required: false
description: 查询限制最大条数
type: integer
format: int32
- name: offset
in: query
required: false
description: 查询游标
type: integer
format: int32
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ListAccessConfig'
'400':
description: 请求参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/lts-log-group:
post:
tags:
- 日志管理
summary: 创建日志组
operationId: CreateLogGroup
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: CreateLogGroup
in: body
required: true
description: 创建日志组结构体
schema:
$ref: '#/definitions/CreateLogGroupReq'
responses:
'200':
description: 生成成功信息
schema:
$ref: '#/definitions/CreateLogGroupResp'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/list-lts-log-group:
get:
tags:
- 日志管理
summary: 查询所有日志组信息
operationId: ListLogGroup
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 日志组列表
schema:
$ref: '#/definitions/ListLogGroup'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/builds/support-image:
get:
tags:
- 应用包管理
operationId: ListSupportImage
summary: 查询应用包列表
description: 查询应用包列表
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: region
in: query
required: false
type: string
description: region 例cn-north-7
responses:
'200':
description: Build列表
schema:
$ref: '#/definitions/ListSupportImageBody'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_id-timestamp-hostname
type: string
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_id-timestamp-hostname
type: string
x-order: 7
/{project_id}/homepage/fleet-runtime:
get:
tags:
- 首页
operationId: QueryFleetRuntimeState
summary: 首页查询Fleet运行状态汇总接口
description: 首页查询Fleet运行状态汇总接口
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/projectId'
- name: top
in: query
required: false
type: integer
description: 首页获取top k,默认获取全部
- name: order_by
in: query
required: false
type: string
description: >-
获取首页信息的排序方式,支持四个字段的八种排序
instance_count: 按照实例数量升序
-instance_count: 按照实例数量降序
process_count: 按照进程数量升序
-process_count: 按照进程数量降序
server_session_count: 按照会话数量升序
-server_session_count: 按照会话数量降序
creation_time: 按照创建时间升序
-creation_time: 按照创建时间降序
默认按照会话数量降序排序
responses:
'200':
description: 应用进程队列列表
schema:
$ref: '#/definitions/HomepageFleetResp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/resource-specification:
post:
tags:
- 实例规格管理
summary: 创建实例规格
description: 创建实例规格
operationId: CreateResourceSpecification
parameters:
- $ref: '#/parameters/projectId'
- name: ResourceSpecificationRequest
in: body
required: true
description: 创建实例规格请求体
schema:
$ref: '#/definitions/ResourceSpecificationRequest'
- $ref: '#/parameters/Auth-token'
responses:
'201':
description: 创建成功响应
schema:
$ref: '#/definitions/ResponseForCreateResourceSpecification'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
x-order: 0
get:
tags:
- 实例规格管理
summary: 获取实例规格详情
description: 获取实例规格详情
operationId: ListResourceSpecification
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- name: name
in: query
required: false
description: 实例规格名字,支持模糊搜索
type: string
minLength: 1
maxLength: 1024
- name: instance_type
in: query
required: false
description: 实例类型
type: string
responses:
'201':
description: 创建成功响应
schema:
$ref: '#/definitions/ResponseForListResourceSpecification'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
put:
tags:
- 实例规格管理
operationId: UpdateResourceSpecification
summary: 更新实例规格基本信息
description: 更新实例规格基本信息,更新前请确认fleet是否关联ResourceSpecification,若关联,则无法被修改
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- in: body
name: UpdateResourceSpecificationRequest
description: 修改的实例规格数据
required: true
schema:
$ref: '#/definitions/UpdateResourceSpecificationRequest'
responses:
'204':
description: 更新实例规格基本信息成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 2
/{project_id}/user/inbound-permission:
get:
tags:
- 用户管理
summary: 获取租户可操作的所有安全组
description: 获取租户可操作的所有安全组
operationId: InboundPermission
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 返回安全组id和name
schema:
items:
$ref: '#/definitions/security_group'
type: array
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/user/resource-specification:
get:
tags:
- 用户管理
summary: 获取租户可操作的所有实例规格
description: 获取租户可操作的所有实例规格
operationId: ResourceSpecification
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 返回安全组id和name
schema:
items:
$ref: '#/definitions/security_group'
type: array
'400':
description: 输入参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/resource-specification/{resource_specification_id}:
get:
tags:
- 实例规格管理
summary: 获取实例规格基本信息
description: 获取实例规格基本信息
operationId: ShowResourceSpecification
parameters:
- $ref: '#/parameters/projectId'
- name: resource_specification_id
in: path
required: true
type: string
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'201':
description: 创建成功响应
schema:
$ref: '#/definitions/ResponseForShowResourceSpecification'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
type: string
x-order: 3
delete:
tags:
- 实例规格管理
operationId: DeleteResourceSpecification
summary: 删除实例规格
description: 删除前请确认fleet是否关联ResourceSpecification,若关联,则无法被删除
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- name: resource_specification_id
in: path
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 删除实例规格成功
schema:
type: string
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
x-order: 4
/project_id/available-zone:
get:
tags:
- 其他资源管理
summary: 获取创建ECS的可用区
operationId: GetAvailableZones
parameters:
- name: region
in: query
required: true
description: 区域
type: string
responses:
'200':
description: 获取成功
schema:
type: array
items:
$ref: '#/definitions/AvaliableZone'
'500':
description: 获取可用区失败
schema:
$ref: '#/definitions/ErrorRsp'
/admin/upgrade:
put:
tags:
- 用户管理
summary: 提升用户权限
description: 提升用户权限
operationId: AdminUserUpgrade
consumes:
- application/x-www-form-urlencoded
parameters:
- $ref: '#/parameters/Auth-token'
- name: id
in: query
required: false
description: 用户id
type: string
responses:
'200':
description: ''
schema:
type: string
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 2
/{project_id}/event:
get:
tags:
- 事件审计
operationId: ListEvents
summary: 查询事件列表
description: 查询事件列表
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- name: resource_type
in: query
required: false
description: >-
事件涉及的资源类型
* user:用户类型
* fleet: fleet
* instance:实例
* process:进程
* session:会话
* build: 应用包
* request: 网络请求
type: string
minLength: 1
maxLength: 64
enum:
- user
- fleet
- instance
- process
- session
- build
- request
- name: trace_state
in: query
required: false
description: >-
事件的等级
* NORMAL:正常
* WARNING: 警告
* INCIDENT:事故
type: string
minLength: 1
maxLength: 64
enum:
- NORMAL
- WARNING
- INCIDENT
- name: event_type
in: query
required: false
description: >-
事件的类型
* data:数据类型
* manager: 管理类型
type: string
minLength: 1
maxLength: 64
enum:
- data
- manager
- name: start_time
in: query
required: false
description: >-
查询事件的起始时间:时间格式:2023-06-14T06:53:31Z 标准时间
type: string
minLength: 1
maxLength: 64
- name: end_time
in: query
required: false
description: >-
查询事件的结束时间:时间格式:2023-06-14T06:53:31Z 标准时间
type: string
minLength: 1
maxLength: 64
- name: id
in: query
required: false
description: >-
事件ID
type: string
minLength: 1
maxLength: 64
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ListEventsResp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
/{project_id}/event/{event_id}:
get:
tags:
- 事件审计
operationId: ShowEvent
summary: 查询事件基本信息
description: 查询事件基本信息
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/eventId'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ShowEventResponse'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
delete:
tags:
- 事件审计
operationId: DeleteEvent
summary: 删除事件
description: 删除事件
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/eventId'
responses:
'204':
description: 删除成功
schema:
type: string
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
/{project_id}/topic:
post:
tags:
- 事件审计
operationId: CreateTopic
summary: 创建主题
description: 创建主题,对于一个projectID,主题是惟一的
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- in: body
name: CreateTopic
description: 创建主题的请求体
required: true
schema:
$ref: '#/definitions/CreateTopicRequest'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ShowTopicResp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
get:
tags:
- 事件审计
operationId: ShowTopic
summary: 查看主题
description: 查看主题
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ShowTopicResp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
put:
tags:
- 事件审计
operationId: UpdateTopic
summary: 修改主题
description: 修改主题
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- in: body
name: CreateTopic
description: 修改主题的请求体
required: true
schema:
$ref: '#/definitions/UpdateTopicRequest'
responses:
'202':
description: ''
schema:
type: string
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
delete:
tags:
- 事件审计
operationId: DeleteTopic
summary: 删除主题
description: 删除主题
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
responses:
'204':
description: 删除主题成功
schema:
type: string
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
/{project_id}/topic/subscriptions/{urn}:
post:
tags:
- 事件审计
operationId: AddSubscription
summary: 为主题添加订阅
description: 为主题添加订阅,一个主题最多添加50个订阅者
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- name: urn
in: path
type: string
description: topic的Urn
required: true
- in: body
name: CreateTopic
description: 为主题添加订阅的请求体
required: true
schema:
$ref: '#/definitions/AddSubscriptionRequest'
responses:
'202':
description: ''
schema:
type: string
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
delete:
tags:
- 事件审计
operationId: CancelSubscription
summary: 取消订阅
description: 取消订阅
x-is-registered: 'N'
x-support-sdk: 'N'
produces:
- application/json
parameters:
- $ref: '#/parameters/projectId'
- name: urn
in: path
type: string
description: 订阅者的Urn
required: true
responses:
'202':
description: 取消订阅成功
schema:
type: string
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: Internal Server Error.
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
/admin/bindres:
post:
tags:
- 用户管理
summary: 管理员为用户绑定已有租户
operationId: BindResConf
parameters:
- name: ResourceConfig
in: body
required: true
description: 绑定租户信息
schema:
$ref: '#/definitions/BindResConf'
- $ref: '#/parameters/Auth-token'
responses:
'201':
description: 请求成功
schema:
$ref: '#/definitions/ResConfig'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 4
/{project_id}/fleets/scaling-policies:
post:
tags:
- 伸缩策略管理
summary: 创建弹性伸缩策略
description: 创建弹性伸缩策略
operationId: CreateScalingPolicy
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: CreateScalingPolicyRequestBody
in: body
description: 创建弹性策略请求体
required: true
schema:
$ref: '#/definitions/CreateScalingPolicyRequestBody'
responses:
'201':
description: 更新弹性伸缩策略成功响应
schema:
$ref: '#/definitions/CreateScalingPolicyResponsetBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
get:
tags:
- 伸缩策略管理
summary: 获取弹性伸缩配置列表
description: 获取弹性伸缩策略列表
operationId: ListScalingPolicies
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
responses:
'200':
description: 应用进程队列的弹性伸缩策略列表
schema:
$ref: '#/definitions/ListScalingPolicyResponseBody'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/{project_id}/fleets/scaling-policies/{policy_id}:
put:
tags:
- 伸缩策略管理
summary: 修改弹性伸缩策略
description: 修改弹性伸缩策略
operationId: UpdateScalingPolicy
x-is-registered: 'Y'
x-support-sdk: 'Y'
parameters:
- $ref: '#/parameters/Auth-token'
- name: policy_id
in: path
required: true
type: string
description: 弹性伸缩策略id
minLength: 1
maxLength: 128
- $ref: '#/parameters/projectId'
- name: UpdateScalingPolicyRequestBody
in: body
description: 更新弹性伸缩策略请求体
required: true
schema:
$ref: '#/definitions/UpdateScalingPolicyRequestBody'
responses:
'204':
description: 更新应用进程队列弹性伸缩策略成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
delete:
tags:
- 伸缩策略管理
operationId: DeleteScalingPolicy
summary: 删除弹性伸缩策略
description: 删除弹性伸缩策略
x-is-registered: 'Y'
x-support-sdk: 'Y'
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: policy_id
in: path
required: true
type: string
description: 弹性伸缩策略id
minLength: 1
maxLength: 128
- $ref: '#/parameters/projectId'
responses:
'204':
description: 删除弹性伸缩策略成功
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: 这个字段作为一个请求的唯一标志,用于任务流程追溯,格式为 request_id(uuid)-timestamp-hostname
/v1/{project_id}/fleets/scaling-policies/{policy_id}/bind:
get:
tags:
- 伸缩策略管理
summary: 获取绑定策略的Fleet信息
operationId: ListFleetsByPolicy
parameters:
- $ref: '#/parameters/projectId'
- name: policy_id
in: path
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RelatedFleetListResp'
'500':
description: 请求失败
schema:
$ref: '#/definitions/ErrorRsp'
/v1/{project_id}/fleets/{fleet_id}/bind:
get:
tags:
- 伸缩策略管理
operationId: ListPolicyByFleet
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 获取成功
schema:
$ref: '#/definitions/AssociatedPolicyOfFleet'
'500':
description: 获取失败
schema:
$ref: '#/definitions/ErrorRsp'
/v1/{project_id}/fleets/scaling-policies/{policy_id}:
get:
tags:
- 伸缩策略管理
summary: 获取单个策略详情
operationId: GetOnePolicy
parameters:
- $ref: '#/parameters/projectId'
- name: policy_id
in: path
required: true
type: string
description: 伸缩策略id
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 请求成功
schema:
$ref: '#/definitions/AssociatedPolicyOfFleet'
'500':
description: 请求错误
schema:
$ref: '#/definitions/ErrorRsp'
/v1/{project_id}/fleets/{fleet_id}/scaling-policies/{policy_id}/bind:
put:
tags:
- 伸缩策略管理
summary: 将伸缩策略绑定一个Fleet
operationId: PolicyBindFleet
parameters:
- name: policy_id
in: path
required: true
type: string
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 绑定成功
schema:
type: string
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
delete:
tags:
- 伸缩策略管理
summary: 解除伸缩策略和Fleet的绑定关系
operationId: PolicyUnBindFleet
parameters:
- name: policy_id
in: path
required: true
type: string
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/fleetId'
- $ref: '#/parameters/Auth-token'
responses:
'204':
description: 解绑成功
schema:
type: string
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/resource_name:
get:
tags:
- 资源监控
operationId: GetResourceMessage
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: 服务器名字和id
schema:
type: array
items:
$ref: '#/definitions/ResourceMessage'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
/{project_id}/resource-monitoring:
get:
tags:
- 资源监控
operationId: ListResourceMonitoring
parameters:
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/Auth-token'
- name: ResourceMonitoringReq
in: body
required: false
schema:
$ref: '#/definitions/ResourceMonitoringReq'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/BatchListMetricDataResponse'
'400':
description: 参数错误
schema:
$ref: '#/definitions/ErrorRsp'
'500':
description: 服务器内部错误
schema:
type: string
/{project_id}/builds/support-docker-image:
get:
tags:
- 应用包管理
operationId: ListSupportDockerImage
summary: 查询应用包列表
description: 查询应用包列表
produces:
- application/json
parameters:
- $ref: '#/parameters/Auth-token'
- name: project_id
in: path
description: ID of project
required: true
type: string
minLength: 32
maxLength: 36
- name: region
in: query
required: false
type: string
description: region 例cn-north-7
responses:
'200':
description: Build列表
schema:
$ref: '#/definitions/ListSupportImageBody'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_id-timestamp-hostname
type: string
'400':
description: Error response
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
type: string
description: >-
This field is the request ID number for task tracking. Format is
request_uuid-timestamp-hostname.
'500':
description: ''
schema:
$ref: '#/definitions/ErrorRsp'
headers:
X-Request-Id:
description: >-
This field is the request ID number for task tracking. Format is
request_id-timestamp-hostname
type: string
x-order: 7
/{project_id}/user/swr-organization:
get:
tags:
- 其他资源管理
summary: 获取当前资源账号swr组织列表
description: 获取当前资源账号swr组织列表
operationId: UserSwrOrganization
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
items:
type: string
type: array
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 7
post:
tags:
- 其他资源管理
summary: 创建SWR组织
description: 创建SWR组织
operationId: CreateUserSwrOrganization
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
- name: body
in: body
required: true
schema:
$ref: '#/definitions/CreateSwrOrganization'
responses:
'200':
description: OK
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 7
/{project_id}/user/swr-image:
get:
tags:
- 其他资源管理
summary: 获取当前资源账号指定region镜像列表
description: 获取当前资源账号指定region 镜像列表
operationId: UserSWRImage
parameters:
- $ref: '#/parameters/projectId'
- name: region
in: query
required: true
type: string
- $ref: '#/parameters/Auth-token'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserDockerImageResponse'
'500':
description: 服务器内部错误
schema:
$ref: '#/definitions/ErrorRsp'
x-order: 7
definitions:
CreateFleetRequestBody:
description: 创建应用进程队列请求体
properties:
instance_type:
type: string
description: 实例类型,只支持VM,POD,VM是ECS,POD是容器
name:
type: string
description: 应用进程队列的名称. 可以不唯一.
minLength: 1
maxLength: 1024
example: MyDemo
description:
type: string
description: 应用进程队列描述
minLength: 1
maxLength: 1024
example: this is a demo
build_id:
type: string
description: 应用包id,创建后不支持修改
example: build-52d872a5-acd3-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
region:
type: string
default: cn-north-4
example: cn-north-4
description: |-
应用进程队列所在的region,只支持北京四region
* cn-north-4: 北京四
enum:
- cn-north-4
public_ip:
$ref: '#/definitions/PublicIp'
description: ECS的IP配置
enterprise_project_id:
type: string
description: fleet所在的企业项目,默认为服务部署时所指定的企业项目,若服务部署时没有指定,则为默认企业项目
default: 0
example: 238012fd-0649-4fc8-bb89-bf6fc8b38d72
vpc_id:
type: string
description: VPC id
default: 52d872a5-acd3-11ec-a7e0-6805cab276a1
example: 52d872a5-acd3-11ec-a7e0-6805cab276a1
subnet_id:
type: string
description: 子网id
default: 52d872a5-acd3-11ec-a7e0-6805cab276a1
example: 52d872a5-acd3-11ec-a7e0-6805cab276a1
server_session_protection_policy:
type: string
description: >-
服务服务器会话保护策略
* NO_PROTECTION: 不保护,缩容时如果有会话在实例上运行,直接缩容
* FULL_PROTECTION: 完全保护,缩容时如果有会话在实例上运行,等待会话结束再缩容
* TIME_LIMIT_PROTECTION:
限时保护,缩容时如果有会话在实例上运行,等待一定时间后缩容,等待时间由server_session_protection_time_limit_minutes指定
example: NO_PROTECTION
enum:
- NO_PROTECTION
- FULL_PROTECTION
- TIME_LIMIT_PROTECTION
server_session_protection_time_limit_minutes:
type: integer
format: int32
description: server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一天
minimum: 5
maximum: 1440
default: 5
example: 5
resource_creation_limit_policy:
$ref: '#/definitions/ResourceCreationLimitPolicy'
description: 对客户端在指定时间内可以创建的服务器会话数量进行限制的策略。通过这个策略,你可以控制客户端消耗可用资源的能力。
runtime_configuration:
$ref: '#/definitions/RuntimeConfiguration'
description: 应用进程队列的运行时配置信息
inbound_permissions:
type: array
minItems: 1
maxItems: 50
description: 访问配置,即允许外部访问应用进程的IP地址和端口描述
items:
$ref: '#/definitions/IpPermission'
instance_tags:
type: array
description: 实例标签数组,仅instance_type为VM时生效
minItems: 0
maxItems: 10
items:
$ref: '#/definitions/InstanceTag'
scaling_group_capacity:
description: 伸缩组实例初始容量参数
$ref: '#/definitions/ScalingGroupCapacity'
resource_specification_id:
type: string
description: 实例规格id
security_group_ids:
type: array
items:
type: string
description: 安全组id
available_zones:
type: array
description: 创建实例资源的可用区,可通过接口获取,为空时随机选择可用区(推荐),不为空则按照可用区优先顺序创建,仅instance_type为VM时生效
example:
- cn-north-4a
items:
type: string
minItems: 0
maxItems: 10
required:
- instance_type
- name
- build_id
- vpc_id
- runtime_configuration
- inbound_permissions
- resource_specification_id
type: object
CreateFleetResponseBody:
required:
- fleet
properties:
fleet:
$ref: '#/definitions/Fleet'
ShowFleetResponseBody:
required:
- fleet
properties:
fleet:
$ref: '#/definitions/Fleet'
type: object
ProcessConfiguration:
description: 应用进程描述
properties:
launch_path:
type: string
description: 应用进程启动程序路径,linux风格文件路径
example: /home/scase/start_up.sh
minLength: 0
maxLength: 1024
parameters:
type: string
description: 应用进程启动入参
example: '--port=1234'
minLength: 0
maxLength: 1024
concurrent_executions:
type: integer
description: 并发应用进程数
example: 1
minimum: 1
maximum: 50
required:
- launch_path
- parameters
- concurrent_executions
PublicIp:
description: ECS的ip配置
properties:
ip_type:
type: string
description: 公共ip池的类型,目前只支持5_bgp与5_sbgp
minLength: 1
maxLength: 64
example: 5_bgp
default: 5_bgp
bandwidth:
$ref: '#/definitions/Bandwidth'
Bandwidth:
description: 带宽配置
properties:
share_type:
type: string
description: |-
带宽的类型:
PER: 独享带宽
WHOLE: 共享带宽
minLength: 1
maxLength: 64
example: PER
default: PER
enum:
- PER
- WHOLE
size:
type: integer
format: int32
minimum: 1
maximum: 2000
default: 1
example: 1
description: 应用队列单实例公网出带宽最大值,默认1Mbps,范围1-200Mbps,可提单提高配额
charging_mode:
type: string
description: |-
带宽的计费方式:
traffic:按流量计费
bandwidth: 按带宽计费
minLength: 1
maxLength: 64
example: traffic
default: traffic
enum:
- bandwidth
- traffic
id:
type: string
description: 共享带宽的id,当带宽类型为共享带宽时,该项必选
minLength: 1
maxLength: 64
example: ''
default: ''
Fleet:
description: 应用进程队列
properties:
instance_type:
type: string
description: 实例类型,只支持VM,POD
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
name:
type: string
description: 应用进程队列的名称. 可以不唯一.
minLength: 1
maxLength: 1024
example: MyDemo
description:
type: string
description: 应用队列描述
minLength: 1
maxLength: 1024
example: this is a demo
region:
type: string
default: cn-north-4
description: 应用进程队列所在的region,只支持北京四region - cn-north-4 北京四
enum:
- cn-north-4
example: cn-north-4
state:
type: string
description: |-
队列状态
* CREATING: 创建中
* ACTIVE: 活跃
* ERROR: 错误
* DELETING: 删除中
* TERMINATED: 已终止
enum:
- CREATING
- ACTIVE
- ERROR
- DELETING
- TERMINATED
example: CREATING
build_id:
type: string
description: 应用包id,创建后不支持修改,用户创建应用包后返回的id
example: build-52d872a5-acd3-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
bandwidth_size:
type: integer
format: int32
minimum: 1
maximum: 200
default: 1
example: 1
description: 应用队列单实例公网出带宽最大值,默认1Mbps,范围1-200Mbps,可提单提高配额
bandwidth_share_type:
type: string
default: PRE
example: PRE
description: 应用队列单实例公网带宽的类型,支持共享与独享类型
enum:
- PRE
- WHOLE
instance_specification:
type: string
description: |-
实例规格,当前只支持2种标准型
* scase.standard.4u8g
* scase.standard.8u16g
default: scase.standard.4u8g
example: scase.standard.4u8g
enum:
- scase.standard.4u8g
- scase.standard.8u16g
operating_system:
type: string
description: 操作系统类型
minLength: 1
maxLength: 128
example: linux
server_session_protection_policy:
type: string
description: >-
服务服务器会话保护策略
* NO_PROTECTION: 不保护,缩容时如果有会话在实例上运行,直接缩容
* FULL_PROTECTION: 完全保护,缩容时如果有会话在实例上运行,等待会话结束再缩容
* TIME_LIMIT_PROTECTION:
限时保护,缩容时如果有会话在实例上运行,等待一定时间后缩容,等待时间由server_session_protection_time_limit_minutes指定
example: NO_PROTECTION
enum:
- NO_PROTECTION
- FULL_PROTECTION
- TIME_LIMIT_PROTECTION
server_session_protection_time_limit_minutes:
type: integer
format: int32
description: server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一天
minimum: 5
maximum: 1440
default: 5
example: 5
enable_auto_scaling:
type: boolean
description: 是否使能自动弹性伸缩,默认值为true,为false时策略仍旧存在,但是不会触发弹性伸缩动作
default: 'true'
example: 'true'
resource_creation_limit_policy:
$ref: '#/definitions/ResourceCreationLimitPolicy'
creation_time:
type: string
description: 应用进程队列创建时间,结束时间,UTC时间,遵循RFC3339规范,例如2019-12-09T06:10:29Z
minLength: 1
maxLength: 32
example: '2020-06-28T00:00:00Z'
instance_tags:
type: array
description: 实例标签数组
minItems: 0
maxItems: 10
items:
$ref: '#/definitions/InstanceTag'
enterprise_project_id:
type: string
description: 应用进程队列所在的企业项目
minLength: 1
maxLength: 1024
type: object
InstanceTag:
properties:
key:
type: string
description: 标签的键
example: key
minLength: 1
maxLength: 36
value:
type: string
description: 标签的值
example: value
minLength: 0
maxLength: 36
required:
- key
IpPermission:
properties:
protocol:
description: |
传输层协议
* TCP: TCP协议
* UDP: UDP协议
type: string
example: TCP
enum:
- TCP
- UDP
ip_range:
type: string
description: IP 段范围,合法的 CIDR 地址类型,只支持IPv4,如所有IPv4来源:0.0.0.0/0
example: 0.0.0.0/0
minLength: 9
maxLength: 18
from_port:
type: integer
minimum: 1025
maximum: 60000
description: 起始端口号
example: 1025
to_port:
type: integer
minimum: 1025
maximum: 60000
example: 1025
description: 结束端口号
required:
- protocol
- ip_range
- from_port
- to_port
HomepageFleetResp:
properties:
total_count:
type: integer
format: int32
description: 当前处于ACTIVE的应用进程队列总数量
minimum: 0
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 已查询出的处于ACTIVE的应用进程队列的数量
minimum: 0
maximum: 2147483647
example: 1
fleets:
type: array
minItems: 0
maxItems: 2147483647
description: 应用进程队列详细信息
items:
$ref: '#/definitions/HomepageFleet'
HomepageFleet:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
name:
type: string
description: 应用进程队列的名称. 可以不唯一.
minLength: 1
maxLength: 1024
example: MyDemo
state:
type: string
description: |-
队列状态
* CREATING: 创建中
* ACTIVE: 活跃
* ERROR: 错误
* DELETING: 删除中
* TERMINATED: 已终止
enum:
- CREATING
- ACTIVE
- ERROR
- DELETING
- TERMINATED
example: CREATING
creation_time:
type: string
description: 应用进程队列创建时间,结束时间,UTC时间,遵循RFC3339规范,例如2019-12-09T06:10:29Z
minLength: 1
maxLength: 32
example: '2020-06-28T00:00:00Z'
instance_count:
type: integer
format: int32
description: 正常的实例总数量
minimum: 0
maximum: 2147483647
example: 1
process_count:
type: integer
format: int32
description: 正常的进程总数量
minimum: 0
maximum: 2147483647
example: 1
server_session_count:
type: integer
format: int32
description: 正常的会话总数量
minimum: 0
maximum: 2147483647
example: 1
instances:
description: 服务器会话列表
minItems: 0
maxItems: 100
type: array
items:
$ref: '#/definitions/InstanceStateCount'
app_processes:
description: 服务器会话列表
minItems: 0
maxItems: 100
type: array
items:
$ref: '#/definitions/ProcessCount'
server_sessions:
description: 服务器会话列表
minItems: 0
maxItems: 100
type: array
items:
$ref: '#/definitions/ServerSessionStateCount'
InstanceStateCount:
properties:
state:
type: string
minLength: 1
maxLength: 64
description: >-
实例的健康状态
* ERROR:异常状态
* NORMAL: 正常状态
* INITAILIZING:初始化
enum:
- ERROR
- NORMAL
- INITAILIZING
example: NORMAL
count:
type: integer
format: int32
description: 总数量
minimum: 0
maximum: 2147483647
example: 1
ServerSessionStateCount:
properties:
state:
type: string
minLength: 1
maxLength: 64
description: >-
服务器会话当前所属的状态
* ACTIVATING: 激活中
* ACTIVE: 活跃
* TERMINATING: 终止中
* TERMINATED: 终止
* ERROR: 异常
enum:
- ACTIVATING
- ACTIVE
- TERMINATING
- TERMINATED
- ERROR
example: ACTIVATING
count:
type: integer
format: int32
description: 总数量
minimum: 0
maximum: 2147483647
example: 1
ErrorRsp:
description: 失败时返回的错误对象
properties:
error_code:
description: 错误码
type: string
minLength: 8
maxLength: 36
error_msg:
description: 错误描述
type: string
minLength: 2
maxLength: 512
required:
- error_code
- error_msg
ListMonitorInstancesResponceBody:
properties:
total_count:
type: integer
format: int32
description: 实例总数量
minimum: 0
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 筛选出的实例数量
minimum: 0
maximum: 100
example: 1
instances:
type: array
description: 实例数组
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/MonitorInstance'
ListMonitorAppProcessResponceBody:
properties:
total_count:
type: integer
format: int32
description: 进程总数量
minimum: 0
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 筛选出的进程数量
minimum: 0
maximum: 100
example: 1
app_processes:
type: array
description: 进程数组
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/MonitorAppProcess'
MonitorAppProcess:
allOf:
- $ref: '#/definitions/Process'
properties:
instance_id:
type: string
description: 实例的id
minLength: 1
maxLength: 64
example: 6066645a-b078-4a00-90d1-7f10aaf87a5b
MonitorInstance:
properties:
instance_id:
type: string
description: 实例的id
minLength: 1
maxLength: 64
example: 6066645a-b078-4a00-90d1-7f10aaf87a5b
instance_name:
type: string
description: 实例名
minLength: 1
maxLength: 64
example: Fleet_25b24e04-8d6d-11ed-93a1-fa163ecd2586_aass_config-9SK1IKR8
health_status:
type: string
minLength: 1
maxLength: 64
description: >-
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''实例的健康状态
* ERROR:异常状态
* Active: 激活状态
* :Activing
激活中''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
enum:
- ERROR
- NORMAL
- INITAILIZING
example: NORMAL
created_at:
type: string
minLength: 1
maxLength: 64
description: 实例的创建时间
example: '2023-01-06T10:52:54Z'
active_at:
type: string
description: 实例激活时间
process_count:
type: integer
format: int32
description: 实例上进程的数量
minimum: 0
maximum: 50
example: 1
ip_address:
type: string
minLength: 1
maxLength: 64
description: 实例的公网IP地址
example: 100.93.15.206
server_session_count:
type: integer
format: int32
description: 实例上会话的数量
minimum: 0
maximum: 2500
example: 1
type: object
ListMonitorServerSessionResponceBody:
properties:
total_count:
type: integer
format: int32
description: 会话总数量
minimum: 0
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 筛选出的会话数量
minimum: 0
maximum: 100
example: 1
server_sessions:
type: array
description: 会话数组
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/MonitorServerSession'
MonitorServerSession:
allOf:
- $ref: '#/definitions/ServerSession'
properties:
instance_id:
type: string
description: 会话所在实例的id
minLength: 1
maxLength: 64
example: 77317ac6-acd8-11ec-a7e0-6805cab276a1
process_id:
type: string
description: 会话所在进程的id
minLength: 1
maxLength: 64
example: 77317ac6-acd8-11ec-a7e0-6805cab276a1
ListFleetsResponseBody:
properties:
count:
type: integer
format: int32
description: 应用队列总数
minimum: 0
maximum: 2147483647
example: 1
fleets:
description: 应用进程队列数组
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/Fleet'
type: array
description: 1、把基本信息返回回来
required:
- count
- fleets
RuntimeConfiguration:
properties:
server_session_activation_timeout_seconds:
type: integer
format: int32
description: 下发创建server session请求到server session的状态变为可用状态的超时时间,默认600秒
minimum: 1
maximum: 600
default: 600
example: 600
max_concurrent_server_sessions_per_process:
type: integer
format: int32
description: 单进程最大并发server session数量
default: 1
minimum: 1
maximum: 50
example: 1
process_configurations:
description: 进程配置信息
minItems: 1
maxItems: 50
items:
$ref: '#/definitions/ProcessConfiguration'
type: array
ResourceCreationLimitPolicy:
properties:
policy_period_in_minutes:
type: integer
format: int32
minimum: 1
maximum: 60
default: 1
example: 1
description: >-
同一个creator_id在policy_period_in_minutes指定的时间段内最多只能创建new_sessions_per_creator个服务器会话
new_sessions_per_creator:
type: integer
format: int32
description: 同一个creator_id能在policy_period_in_minutes字段指定的时间段内能创建的最大服务器会话数
minimum: 1
maximum: 60
default: 1
example: 1
UpdateFleetAttributesReuqestBody:
properties:
name:
type: string
minLength: 1
maxLength: 1024
example: fleet-1
description: 应用进程队名称
description:
type: string
minLength: 1
maxLength: 1024
description: 应用进程队列描述信息
example: 描述信息
server_session_protection_policy:
type: string
description: >-
服务服务器会话保护策略
* NO_PROTECTION: 不保护,缩容时如果有会话在实例上运行,直接缩容
* FULL_PROTECTION: 完全保护,缩容时如果有会话在实例上运行,等待会话结束再缩容
* TIME_LIMIT_PROTECTION:
限时保护,缩容时如果有会话在实例上运行,等待一定时间后缩容,等待时间由server_session_protection_time_limit_minutes指定
example: NO_PROTECTION
enum:
- NO_PROTECTION
- FULL_PROTECTION
- TIME_LIMIT_PROTECTION
server_session_protection_time_limit_minutes:
type: integer
format: int32
description: >-
server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一天
minimum: 5
maximum: 1440
default: 5
example: 5
enable_auto_scaling:
type: boolean
description: 是否使能自动弹性伸缩,默认值为false,为false时策略仍旧存在,但是不会触发弹性伸缩动作
default: 'false'
example: 'false'
instance_tags:
type: array
description: 实例标签数组
minItems: 0
maxItems: 10
items:
$ref: '#/definitions/InstanceTag'
resource_creation_limit_policy:
$ref: '#/definitions/ResourceCreationLimitPolicy'
ShowInboundPermissionResponseBody:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
inbound_permissions:
type: array
description: 安全组规则列表
minItems: 1
maxItems: 50
items:
$ref: '#/definitions/IpPermission'
UpdateFleetInboundPermissionsRequestBody:
properties:
inbound_permission_authorizations:
type: array
minItems: 0
maxItems: 50
description: 新增的安全组规则列表
items:
$ref: '#/definitions/IpPermission'
inbound_permission_revocations:
type: array
minItems: 0
maxItems: 50
description: 删除的安全组规则列表
items:
$ref: '#/definitions/IpPermission'
FleetRuntimeConfigurationResponseBody:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
runtime_configuration:
$ref: '#/definitions/RuntimeConfiguration'
FleetEvent:
properties:
event_id:
type: string
minLength: 1
maxLength: 64
example: 53503686-a9af-11ec-828d-fa163ee7efa6
description: 事件id
event_code:
type: string
minLength: 1
maxLength: 64
enum:
- FLEET_CREATED
- FLEET_STATE_ACTIVE
- FLEET_SCALING_EVENT
- FLEET_STATE_ERROR
- FLEET_STATE_DELETING
- FLEET_STATE_TERMINATED
description: |
* FLEET_CREATED: 接收到fleet创建请求,并开始创建fleet资源 -
* FLEET_STATE_ACTIVE: 创建fleet资源成功成功,fleet进入活跃状态 -
* FLEET_SCALING_EVENT: fleet发生弹性伸缩事件
* FLEET_STATE_ERROR: fleet发生异常
* FLEET_STATE_DELETING: fleet接收到删除请求,开始清理资源
* FLEET_STATE_TERMINATED: fleet删除流程完成
example: FLEET_CREATED
event_time:
type: string
minLength: 1
maxLength: 128
description: 事件发生时间,UTC时间,遵循RFC3339规范,例如2019-12-09T06:10:29Z
example: '2020-06-28T00:00:00Z'
message:
type: string
minLength: 1
maxLength: 128
description: 事件描述信息
example: 应用进程队列开始创建
ListFleetEventResponseBody:
properties:
count:
type: integer
format: int32
description: 事件总数
minimum: 0
maximum: 2147483647
example: 1
events:
type: array
description: 事件列表
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/FleetEvent'
ShowFleetCapacityResponseBody:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
instance_capacity:
$ref: '#/definitions/InstanceCapacity'
InstanceCapacity:
properties:
min_instance_number:
type: integer
format: int32
minimum: 0
maximum: 200
description: 应用进程队列在所在region的最小实例数
example: 1
max_instance_number:
type: integer
format: int32
minimum: 0
maximum: 200
description: 应用进程队列在所在region的最大实例数
example: 1
type: object
ListBandwidthsResp:
properties:
count:
type: integer
format: int32
description: 带宽的数量
minimum: 0
example: 1
bandwidths:
type: array
description: 带宽列表
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/BandwidthResponse'
BandwidthResponse:
properties:
id:
type: string
description: 带宽id
example: 53503686-a9af-11ec-828d-fa163ee7efa6
name:
type: string
description: 带宽名
example: Bandwidth
bandwidth_type:
type: string
description: 带宽的类型:share为共享带宽,bgp为动态bgp
example: share
enum:
- share
- bgp
share_type:
type: string
description: 共享带宽的类型标识是否为共享带宽:PRE为独占带宽,WHOLE为共享带宽
example: PRE
enum:
- PRE
- WHOLE
charging_mode:
type: string
description: 带宽的计费方式:bandwidth为按带宽计费,traffic为按流量计费
example: traffic
enum:
- bandwidth
- traffic
size:
type: integer
format: int32
description: 带宽大小
minimum: 0
example: 1
status:
type: string
description: |-
带宽的状态:
- FREEZED:冻结
- NORMAL:正常
example: NORMAL
enum:
- FREEZED
- NORMAL
created_at:
type: string
description: |-
功能说明:资源更新时间,UTC时间
格式: yyyy-MM-ddTHH:mm:ss
example: '0000-00-00T00:00:00'
UpdateFleetInstanceCapacityRequestBody:
properties:
min_instance_number:
type: integer
format: int32
description: 更新后最小实例数
minimum: 0
maximum: 200
example: 1
max_instance_number:
type: integer
format: int32
description: 更新后最大实例数
minimum: 0
maximum: 200
example: 1
required:
- min_instance_number
- max_instance_number
type: object
CreateScalingPolicyRequestBody:
properties:
name:
type: string
description: 伸缩策略名称
minLength: 1
maxLength: 1024
example: name-1
policy_type:
type: string
enum:
- TARGET_BASED
description: |-
伸缩策略类型,只支持基于目标的策略
* TARGET_BASED: 基于目标的策略,只能有一个基于目标的策略
example: TARGET_BASED
target_based_configuration:
$ref: '#/definitions/TargetBasedConfiguration'
required:
- name
- policy_type
- target_based_configuration
TargetBasedConfiguration:
description: 基于目标的伸缩策略配置内容
properties:
metric_name:
type: string
description: |-
指标名称,取值范围
* PERCENT_AVAILABLE_SERVER_SESSIONS: 空闲server session百分比
enum:
- PERCENT_AVAILABLE_SERVER_SESSIONS
default: PERCENT_AVAILABLE_SERVER_SESSIONS
example: PERCENT_AVAILABLE_SERVER_SESSIONS
min_target_value:
type: integer
format: int32
description: 最小可用会话比,低于时扩容
minimum: 1
maximum: 100
max_target_value:
type: integer
format: int32
description: 最大可用会话比,低于时缩容
minimum: 1
maximum: 100
required:
- metric_name
- min_target_value
- max_target_value
type: object
ScalingPolicy:
properties:
policy_id:
type: string
description: 弹性伸缩策略的id
minLength: 1
maxLength: 128
example: 77317ac6-acd8-11ec-a7e0-6805cab276a1
name:
type: string
description: 伸缩策略名称
minLength: 1
maxLength: 1024
example: policy-name1
policy_type:
type: string
description: |-
策略类型
* TARGET_BASED: 基于目标的策略
enum:
- TARGET_BASED
example: TARGET_BASED
target_based_configuration:
$ref: '#/definitions/TargetBasedConfiguration'
required:
- policy_id
- name
- policy_type
- target_based_configuration
type: object
ListScalingPolicyResponseBody:
required:
- count
properties:
total_count:
type: integer
format: int32
description: 策略总个数
minimum: 0
maximum: 50
example: 1
count:
type: integer
format: int32
description: 查询出的策略个数
minimum: 0
maximum: 50
example: 1
scaling_policies:
type: array
minItems: 0
maxItems: 50
description: 弹性伸缩策略列表
items:
$ref: '#/definitions/ScalingPolicy'
UpdateScalingPolicyRequestBody:
properties:
name:
type: string
description: 伸缩策略名称
minLength: 1
maxLength: 1024
example: policy-name1
target_based_configuration:
$ref: '#/definitions/TargetBasedConfiguration'
CreateServerSessionRequestBody:
properties:
creator_id:
type: string
description: 创建者ID,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: id1
name:
type: string
description: 游戏服务器会话名称,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: name1
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: 77317ac6-acd8-11ec-a7e0-6805cab276a1
alias_id:
type: string
description: 应用进程队列别名的id
minLength: 1
maxLength: 64
example: 77317ac6-acd8-11ec-a7e0-6805cab276a1
server_session_properties:
type: array
minItems: 0
maxItems: 16
description: 服务器会话属性列表
items:
$ref: '#/definitions/ServerSessionProperty'
server_session_data:
type: string
description: 游戏服务器会话属性详情,最大长度不超过4096个ASCII字符
minLength: 0
maxLength: 4096
example: data-1
max_client_session_count:
type: integer
format: int32
description: 最大客户端会话数量,最小值不小于0
minimum: 1
maximum: 1024
example: 1
idempotency_token:
type: string
description: 幂等token,最大长度不超过48个ASCII字符
minLength: 0
maxLength: 48
example: token1
required:
- max_client_session_count
ServerSessionProperty:
properties:
key:
type: string
description: 属性名称,最大长度不超过32个ASCII字符
minLength: 1
maxLength: 32
example: key
value:
type: string
description: 属性值,最大长度不超过96个ASCII字符
minLength: 1
maxLength: 96
example: value
required:
- key
- value
ServerSession:
properties:
server_session_id:
type: string
description: 服务器会话的id,全局唯一
minLength: 1
maxLength: 64
example: 43b75508-5c7f-49e0-9982-fe3cf73bdb3a
name:
type: string
description: server session的名字,不要求唯一
minLength: 1
maxLength: 1024
example: session_name1
creator_id:
type: string
description: 创建者的ID
minLength: 1
maxLength: 1024
example: creatorId1
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
server_session_properties:
type: array
minItems: 0
maxItems: 16
items:
$ref: '#/definitions/ServerSessionProperty'
description: 服务器会话属性
server_session_data:
type: string
description: session携带的数据
minLength: 0
maxLength: 262144
example: data-1
current_client_session_count:
type: integer
description: 当前客户端会话数量
minimum: 0
maximum: 1024
example: 1
max_client_session_count:
type: integer
description: 一个服务器会话支持的最大客户端会话数
minimum: 0
maximum: 1024
example: 1
state:
type: string
description: |
服务器会话当前所属的状态
* ACTIVATING: 激活中
* ACTIVE: 活跃
* TERMINATING: 终止中
* TERMINATED: 终止
* ERROR: 异常
enum:
- ACTIVATING
- ACTIVE
- TERMINATING
- TERMINATED
- ERROR
example: ACTIVATING
state_reason:
type: string
description: 状态为ERROR时这个字段表示错误信息
minLength: 1
maxLength: 1024
example: error info
ip_address:
type: string
description: 公网IP,需符合IP地址的规范
example: 100.10.10.90
minLength: 7
maxLength: 15
port:
type: integer
format: int32
description: 进程提供服务的接口(需要符合端口要求:1025~60000)
example: 8080
minimum: 1025
maximum: 60000
client_session_creation_policy:
description: |
新建客户端会话的策略
* ACCEPT_ALL: 接受所有新建客户端会话的请求
* DENY_ALL: 拒绝所有新建客户端会话的请求
type: string
enum:
- ACCEPT_ALL
- DENY_ALL
example: ACCEPT_ALL
server_session_protection_policy:
type: string
description: |
服务服务器会话保护策: >-
服务服务器会话保护策略
* NO_PROTECTION: >-
不保护,缩容时如果有会话在实例上运行,直接缩容
* FULL_PROTECTION: >-
完全保护,缩容时如果有会话在实例上运行,等待会话结束再缩容
* TIME_LIMIT_PROTECTION: >-
限时保护,缩容时如果有会话在实例上运行,等待一定时间后缩容,等待时间由server_session_protection_time_limit_minutes指定
example: NO_PROTECTION
enum:
- NO_PROTECTION
- FULL_PROTECTION
- TIME_LIMIT_PROTECTION
server_session_protection_time_limit_minutes:
type: integer
format: int32
description: |
server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一: >-
server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一天
minimum: 5
maximum: 1440
default: 5
example: 5
creation_time:
description: 标识serversession创建的时间,UTC时间,遵循RFC3339规范
type: string
minLength: 0
maxLength: 2048
example: '2020-06-28T00:00:00Z'
termination_time:
description: 标识serversession终止的时间,UTC时间,遵循RFC3339规范
type: string
minLength: 0
maxLength: 2048
example: '2020-06-28T00:00:00Z'
required:
- name
- server_session_id
- creator_id
- fleet_id
- current_client_session_count
- max_client_session_count
- state
- state_reason
- client_session_creation_policy
- creation_time
- termination_time
ListServerSessionResponseBody:
properties:
count:
type: integer
format: int32
description: 服务器会话个数
minimum: 0
maximum: 2147483647
example: 1
server_sessions:
description: 服务器会话列表
minItems: 0
maxItems: 100
type: array
items:
$ref: '#/definitions/ServerSession'
BatchCreateClientSessionRequestBody:
properties:
clients:
type: array
description: 客户端信息列表
minItems: 1
maxItems: 25
items:
$ref: '#/definitions/Client'
required:
- clients
Client:
required:
- client_id
properties:
client_id:
type: string
description: 客户端id
minLength: 1
maxLength: 128
example: client-1
client_data:
type: string
description: 客户端自定义数据
minLength: 0
maxLength: 128
example: data-1
BatchCreateClientSessionResponseBody:
properties:
count:
type: integer
format: int32
description: 客户端会话数量
minimum: 0
maximum: 2147483647
example: 1
client_sessions:
description: 客户端会话列表
type: array
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/ClientSession'
required:
- count
ClientSession:
properties:
client_session_id:
type: string
description: 客户端会话的id,全局唯一
example: 43b75508-5c7f-49e0-9982-fe3cf73bdb3a
minLength: 1
maxLength: 64
server_session_id:
type: string
description: 服务器会话的id,全局唯一
minLength: 1
maxLength: 64
example: 43b75508-5c7f-49e0-9982-fe3cf73bdb3a
client_id:
description: 租户自定义的玩家ID
type: string
minLength: 1
maxLength: 128
example: client-1
client_data:
type: string
description: 与player相关的数据,租户自定义,系统不使用该数据
minLength: 0
maxLength: 128
example: data-1
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
ip_address:
type: string
description: AuxProxy所在虚拟机的公网IP,需符合IP地址的规范
example: 100.10.10.90
minLength: 7
maxLength: 15
port:
type: integer
minimum: 1025
maximum: 60000
description: 进程提供服务的接口(需要符合端口要求:1~60000)
example: 8080
state:
type: string
description: |
client session所处的状态
* RESERVED: 收到创建请求,客户端尚未接入服务器会话
* ACTIVE: 客户端接入服务器会话
* COMPLETED: 客户端已断开
enum:
- RESERVED
- ACTIVE
- COMPLETED
creation_time:
description: 标识clientsession创建的时间,UTC时间,遵循RFC3339规范
type: string
minLength: 1
maxLength: 32
example: '2020-06-28T00:00:00Z'
termination_time:
description: 标识clientsession终止的时间,UTC时间,遵循RFC3339规范
type: string
minLength: 1
maxLength: 32
example: '2020-06-28T00:00:00Z'
ListMonitorFleetsResponseBody:
properties:
total_count:
type: integer
format: int32
description: 当前处于ACTIVE/CREATING/DELETING的应用进程队列总数量
minimum: 0
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 已查询出的处于ACTIVE/CREATING/DELETING的应用进程队列的数量
minimum: 0
maximum: 2147483647
example: 1
fleets:
type: array
minItems: 0
maxItems: 2147483647
description: 应用进程队列详细信息
items:
$ref: '#/definitions/MonitorFleet'
all_fleet_ids_names:
type: array
minItems: 0
maxItems: 2147483647
description: 所有应用进程队列的id与名字
items:
$ref: '#/definitions/FleetIdAndName'
FleetIdAndName:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 1024
example: 25b24e04-8d6d-11ed-93a1-fa163ecd2586
name:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 1024
example: fleet-name
ShowMonitorFleetResponseBody:
allOf:
- $ref: '#/definitions/MonitorFleet'
MonitorFleet:
allOf:
- $ref: '#/definitions/Fleet'
- type: object
properties:
associated_alias:
type: array
items:
$ref: '#/definitions/associated_alias'
description: 应用进程队列已关联的别名列表
alias_count:
type: integer
format: int32
description: 应用进程队列已关联的别名数量
instance_count:
type: integer
format: int32
description: 应用进程队列的实例数量
process_count:
type: integer
format: int32
description: 应用进程队列的进程数量
server_session_count:
type: integer
format: int32
description: 应用进程队列的会话数量
max_server_session_count:
type: integer
format: int32
description: 应用进程队列的最大会话数量
ListClientSessionResponseBody:
required:
- count
properties:
count:
type: integer
format: int32
description: 客户端会话数量
minimum: 0
maximum: 2147483647
example: 1
client_sessions:
type: array
minItems: 0
maxItems: 100
description: 客户端会话列表
items:
$ref: '#/definitions/ClientSession'
UpdateServerSessionRequestBody:
properties:
name:
type: string
description: server session的名字,不要求唯一
minLength: 1
maxLength: 1024
example: name-1
max_client_session_count:
type: integer
description: 一个服务器会话支持的最大客户端会话数
minimum: 1
maximum: 1024
example: 1
client_session_creation_policy:
type: string
example: ACCEPT_ALL
description: |-
* ACCEPT_ALL: 接受所有新创建client session的请求
* DENY_ALL: 拒绝所有新创建client session的请求
enum:
- ACCEPT_ALL
- DENY_ALL
server_session_protection_policy:
type: string
description: >-
服务服务器会话保护策略 * NO_PROTECTION: 不保护,缩容时如果有会话在实例上运行,直接缩容 *
TIME_LIMIT_PROTECTION:
限时保护,缩容时如果有会话在实例上运行,等待一定时间后缩容,等待时间由server_session_protection_time_limit_minutes指定
example: NO_PROTECTION
enum:
- NO_PROTECTION
- FULL_PROTECTION
- TIME_LIMIT_PROTECTION
server_session_protection_time_limit_minutes:
type: integer
format: int32
description: >-
server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一天
minimum: 5
maximum: 1440
default: 5
example: 5
ProcessCountsResponseBody:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 1
maxLength: 64
example: fleet-77317ac6-acd8-11ec-a7e0-6805cab276a1
process_counts:
type: array
minItems: 0
maxItems: 10
description: 应用进程状态信息数组
items:
$ref: '#/definitions/ProcessCount'
required:
- fleet_id
ProcessCount:
required:
- state
- count
properties:
state:
type: string
description: |
进程状态
* ACTIVATING: 激活中
* ACTIVE: 活跃
* TERMINATING: 终止中
* TERMINATED: 终止
* ERROR: 错误
enum:
- ACTIVATING
- ACTIVE
- TERMINATING
- TERMINATED
- ERROR
example: ACTIVATING
count:
type: integer
format: int32
minimum: 0
maximum: 2147483647
example: 1
description: 处于某种状态的应用进程的数量
CreateClientSessionRequestBody:
required:
- client_id
properties:
client_id:
type: string
description: 客户端id,同一个server session下,client id唯一
minLength: 1
maxLength: 128
example: client-1
client_data:
type: string
description: 客户端自定义数据
minLength: 0
maxLength: 128
example: data-1
CreateScalingPolicyResponsetBody:
properties:
scaling_policy:
$ref: '#/definitions/ScalingPolicy'
required:
- scaling_policy
CreateServerSessionResponseBody:
required:
- server_session
properties:
server_session:
$ref: '#/definitions/ServerSession'
ShowServerSessionResponseBody:
required:
- server_session
properties:
server_session:
$ref: '#/definitions/ServerSession'
CreateClientSessionResponseBody:
required:
- client_session
properties:
client_session:
$ref: '#/definitions/ClientSession'
ShowClientSessionResponseBody:
required:
- client_session
properties:
client_session:
$ref: '#/definitions/ClientSession'
ListProcessResponseBody:
properties:
count:
type: integer
format: int32
description: 应用进程数量
example: 1
maximum: 2147483647
minimum: 0
app_processes:
type: array
items:
$ref: '#/definitions/Process'
description: 应用进程数组
minItems: 0
maxItems: 100
required:
- count
- app_processes
Process:
description: 单个应用进程
properties:
id:
type: string
description: 进程唯一标识ID
example: app-process-a6abeeb5-8098-4833-a891-ec1b3ddccabb
minLength: 1
maxLength: 64
ip:
type: string
description: 公网IP,需符合IP地址的规范
example: 100.10.10.90
minLength: 7
maxLength: 15
port:
type: integer
format: int32
minimum: 1025
maximum: 60000
example: 8080
description: 进程提供服务的接口(需要符合端口要求:1025~60000)
state:
type: string
enum:
- AVTIVATING
- ACTIVE
- ERROR
- DELETING
- TERMINATED
example: AVTIVATING
description: |-
进程状态
* AVTIVATING: 创建中
* ACTIVE: 活跃
* ERROR: 错误
* DELETING: 删除中
* TERMINATED: 已终止
server_session_count:
type: integer
format: int32
description: 已占用服务端会话数
example: 1
minimum: 0
maximum: 1024
max_server_session_num:
type: integer
format: int32
description: 最大服务端会话数
example: 1
minimum: 0
maximum: 1024
ListBuildsResponseBody:
properties:
count:
type: integer
format: int32
description: 应用队列总数
builds:
items:
$ref: '#/definitions/Build'
type: array
description: 应用包列表
required:
- count
- builds
Build:
description: 应用包
properties:
build_id:
type: string
description: 应用包的ID
name:
type: string
description: 应用包名称. Project下唯一
minLength: 1
maxLength: 512
example: MyDemo
description:
type: string
description: 应用包描述
minLength: 2
maxLength: 512
example: this is a demo
state:
type: string
description: 应用包状态(初始化、就绪、校验失败)
enum:
- INITIALIZED
- READY
- FAILED
size:
type: integer
description: 应用包大小(bytes)
example: 123456
creation_time:
type: string
description: 创建时间
version:
type: string
description: 应用包版本
operating_system:
type: string
description: 操作系统类型
build_type:
type: string
description: 应用包类型
type: object
ResConfig:
type: object
description: 包含 用户租户相关信息
properties:
user_id:
type: string
description: 分配资源的目标用户id,全局唯一,uuid格式
minLength: 32
maxLength: 36
example: 00efa289-bc87-11ed-8e05-fa163ecd2586
domain_name:
type: string
description: 租户名,仅用于标识当前project_id
example: b3b22b1e***************03faa
maxLength: 64
project_id:
type: string
description: 项目ID
example: 302afed3b**********5cab2638d
maxLength: 64
access_key:
type: string
description: ak,RSA加密后的密文
maxLength: 1024
example: ''
secret_access_key:
type: string
description: sk,RSA加密后的密文
maxLength: 1024
example: ''
region:
type: string
description: 区域
example: cn-north-4
maxLength: 64
keypair_name:
type: string
description: 密钥名
example: keypair_name_demo
maxLength: 64
agency_name:
type: string
description: 云服务委托
maxLength: 64
auxproxy_path:
type: string
description: AuxProxy路径
maxLength: 1024
build_script_path:
type: string
description: ECS-应用包配置脚本路径
maxLength: 1024
file_storage_region:
type: string
description: 文件存放Region
maxLength: 1024
docker_build_script_path:
type: string
description: 容器-应用包配置脚本路径
required:
- user_id
- domain_name
- project_id
- access_key
- secret_access_key
- region
- keypair_name
DaoBuild:
type: object
description: 应用包详情字段
properties:
id:
type: string
description: 应用包id
build_type:
type: string
description: 应用包类型
project_id:
type: string
description: project_id
name:
type: string
description: 应用包名
description:
type: string
description: 描述
state:
type: string
description: 应用包状态
creation_time:
type: string
format: date-time
description: 创建时间
update_time:
type: string
format: date-time
description: 更新时间
image_id:
type: string
description: 镜像id
image_region:
type: string
description: 镜像所在region
bucket_name:
type: string
description: 应用包OBS存储桶名
key:
type: string
description: 应用包OBS存储对象名
storage_region:
type: string
description: 应用包OBS存储region
operating_system:
type: string
description: 应用操作系统
version:
type: string
description: 应用包版本
size:
type: string
description: 应用包大小
user:
type: string
description: 用户
group:
type: string
description: 用户组
build_state_reason:
type: string
description: 应用包状态原因
UpdateBuildRequestBody:
type: object
description: 更新应用包请求体。会判断name+version的重复
required:
- name
- description
- version
properties:
name:
type: string
description: 更新/原应用包名
minLength: 2
maxLength: 50
pattern: ^[A-Za-z][\dA-Za-z\_\-]{1,49}$
description:
type: string
description: 更新/原描述
minLength: 0
maxLength: 100
version:
type: string
description: 更新/原版本
minLength: 1
maxLength: 50
storage_location:
type: object
description: 应用包路径信息
properties:
bucket_name:
type: string
description: 桶名
minLength: 1
maxLength: 100
bucket_key:
type: string
description: 对象名
minLength: 1
maxLength: 100
required:
- bucket_name
- bucket_key
CreateBuildRequest:
type: object
description: 创建应用包(指定OBS路径)请求体
required:
- build_type
- name
- storage_location
- version
- region
- vpc_id
- subnet_id
- bandwidth
properties:
build_type:
type: string
description: 应用包类型 oneof POD VM
name:
type: string
description: |-
应用包名 小写字母开头 允许小写字母数字下划线 中划线 点
^\[a-z][\da-z_\-.]{1,49}$
minLength: 2
maxLength: 50
pattern: ^\[a-z][\da-z_\-.]{1,49}$
description:
type: string
description: 描述
minLength: 1
maxLength: 1024
operating_system:
type: string
description: 操作系统 选择公有镜像时输入名称,选择私有镜像时输入私有镜像id。后端默认值为公有镜像CentOS 7.2 64bits
minLength: 1
maxLength: 256
storage_location:
description: 应用包存储信息
$ref: '#/definitions/storage_location'
version:
type: string
description: 版本号^\[a-z][\da-z_\-.]{1,49}$
minLength: 1
maxLength: 50
region:
type: string
description: 您的镜像需要打包到哪个region?
minLength: 1
maxLength: 50
vpc_id:
type: string
description: 虚拟私有云id 用于创建ECS
minLength: 1
maxLength: 64
subnet_id:
type: string
description: 子网id 用于创建ECS
minLength: 1
maxLength: 64
enterprise_project:
type: string
description: 企业项目id 用于镜像绑定 选填
minLength: 1
maxLength: 64
user:
type: string
description: 用户
default: root
group:
type: string
description: 用户组
default: root
user_password:
type: string
description: 'linux密码 正则 ^[a-zA-Z\d.\-_=@#]{8,20}$ 大小写字母 数字 . - = _ @ #'
pattern: ^[a-zA-Z\d.\-_=@#]{8,20}$
operating_system_type:
type: integer
format: int32
description: 公有为0,私有为1
default: 0
bandwidth:
description: 应用包EIP设置
$ref: '#/definitions/buildbandwidth'
organization:
type: string
description: SWR组织 选择容器时为必填
QueryBuildParam:
type: object
description: 查询应用包参数
properties:
name:
type: string
minLength: 1
maxLength: 50
state:
type: string
creation_time:
type: string
description: 起时间/止时间
UploadBuildResponse:
type: object
description: 上传应用包至OBS返回参数
required:
- bucket_name
- bucket_key
- storage_region
properties:
bucket_name:
type: string
description: 桶名
bucket_key:
type: string
description: 对象名
storage_region:
type: string
description: 存储区域
UserInfo:
type: object
properties:
username:
type: string
description: 用户名
minLength: 4
maxLength: 31
example: user1
password:
type: string
description: 用户登录密码
example: '''*******'''
email:
type: string
description: 邮箱
example: '*******'
phone:
type: string
description: 电话
example: 13800000000
activation:
type: integer
format: int32
description: 激活状态 1激活,0未激活,-1冻结
usertype:
type: integer
format: int32
description: 用户类型,0普通用户,9管理员
TotalResNumber:
type: integer
format: int32
description: 该用户拥有的租户数量
required:
- username
- password
UserBucketResponse:
type: object
description: 获取资源账号特定区域桶名列表 响应体
required:
- count
- bucket_name
properties:
count:
type: string
bucket_name:
type: array
items:
type: string
AssociatedFleet:
properties:
fleet_id:
type: string
description: 应用进程队列的id
minLength: 0
maxLength: 64
example: 0051ee5c-609b-11ed-bb1e-fa163ecd2586
weight:
type: integer
format: int32
description: 应用进程队列的权重,范围0-100表示权重百分比
minimum: 0
maximum: 100
example: 1
type: object
AssociatedFleetResponse:
properties:
name:
type: string
description: fleet名称
minLength: 0
maxLength: 1024
example: this is a fleet demo
fleet_id:
type: string
description: 应用进程队列的id
minLength: 0
maxLength: 64
example: 0051ee5c-609b-11ed-bb1e-fa163ecd2586
weight:
type: integer
format: int32
description: 应用进程队列的权重,范围0-100表示权重百分比
minimum: 0
maximum: 100
example: 1
state:
type: string
description: |-
队列状态
* CREATING: 创建中
* ACTIVE: 活跃
* ERROR: 错误
* DELETING: 删除中
* TERMINATED: 已终止
enum:
- CREATING
- ACTIVE
- ERROR
- DELETING
- TERMINATED
example: ACTIVE
instance_count:
type: integer
format: int32
description: 该应用进程队列内存在的实例数量
minimum: 0
maximum: 2147483647
example: 1
process_count:
type: integer
format: int32
description: 该应用进程队列内存在的进程数量
minimum: 0
maximum: 2147483647
example: 1
server_session_count:
type: integer
format: int32
description: 该应用进程队列内存在的服务会话数量
minimum: 0
maximum: 2147483647
example: 1
max_server_session_num:
type: integer
format: int32
description: 该应用进程队列支持的最大服务会话数量
minimum: 0
maximum: 2147483647
example: 1
type: object
CreateAliasRequestBody:
properties:
name:
type: string
description: 别名名称,最大长度不超过1024个ASCII字符
minLength: 1
maxLength: 1024
example: alias-name
description:
type: string
description: 别名描述,最大长度不超过1024个ASCII字符
minLength: 1
maxLength: 1024
example: alias-description
type:
type: string
description: |-
别名的类型
* ACTIVE: 激活类型,该类型的alias可以指向flee列表t,并且可以使用该alias创建会话
* DEACTIVE: 停用类型,该类型的alias不会指向fleet,使用该alias创建会话会直接返回该结构体中message的信息
enum:
- ACTIVE
- DEACTIVE
example: ACTIVE
message:
type: string
description: 别名的信息,用于DEACTIVE类型的别名创建会话时的返回信息,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-message
associated_fleets:
type: array
description: 别名关联的fleet
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/AssociatedFleet'
required:
- name
- description
- type
UpdateAliasRequestBody:
properties:
name:
type: string
description: 别名名称,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-name
description:
type: string
description: 别名描述,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-description
type:
type: string
description: |-
别名的类型
* ACTIVE: 激活类型,该类型的alias可以指向flee列表t,并且可以使用该alias创建会话
* DEACTIVE: 停用类型,该类型的alias不会指向fleet,使用该alias创建会话会直接返回该结构体中message的信息
enum:
- ACTIVE
- DEACTIVE
example: ACTIVE
message:
type: string
description: 别名的信息,用于DEACTIVE类型的别名创建会话时的返回信息,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-message
associated_fleets:
type: array
description: 别名关联的fleet
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/AssociatedFleet'
CreateAliasResponseBody:
allOf:
- $ref: '#/definitions/UpdateAliasRequestBody'
properties:
alias_id:
type: string
description: 别名ID,随机生成的UUID
minLength: 0
maxLength: 64
example: 0051ee5c-609b-11ed-bb1e-fa163ecd2586
creation_time:
type: string
description: 别名队列创建时间,结束时间,UTC时间,遵循RFC3339规范,例如2019-12-09T06:10:29Z
minLength: 1
maxLength: 32
example: '2020-06-28T00:00:00Z'
ShowAliasResponseBody:
allOf:
- $ref: '#/definitions/Alias'
ListAliasResponseBody:
properties:
total_count:
type: integer
format: int32
description: 别名总数
minimum: 0
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 查询出的别名数量
minimum: 0
maximum: 2147483647
example: 1
aliases:
description: 应用进程队列数组
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/Alias'
type: array
Alias:
properties:
alias_id:
type: string
description: 别名ID,随机生成的UUID
minLength: 0
maxLength: 64
example: 0051ee5c-609b-11ed-bb1e-fa163ecd2586
name:
type: string
description: 别名名称,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-name
description:
type: string
description: 别名描述,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-description
creation_time:
type: string
description: 别名队列创建时间,结束时间,UTC时间,遵循RFC3339规范,例如2019-12-09T06:10:29Z
minLength: 1
maxLength: 32
example: '2020-06-28T00:00:00Z'
type:
type: string
description: |-
别名的类型
* ACTIVE: 激活类型,该类型的alias可以指向flee列表t,并且可以使用该alias创建会话
* DEACTIVE: 停用类型,该类型的alias不会指向fleet,使用该alias创建会话会直接返回该结构体中message的信息
* TERMINATED: 表示该Alias已被删除
enum:
- ACTIVE
- DEACTIVE
- TERMINATED
example: ACTIVE
message:
type: string
description: 别名的信息,用于DEACTIVE类型的别名创建会话时的返回信息,最大长度不超过1024个ASCII字符
minLength: 0
maxLength: 1024
example: alias-message
associated_fleets:
type: array
description: alias所关联的fleet列表
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/AssociatedFleetResponse'
ListOriginInfoResponseBody:
type: object
description: 使用租户信息响应体
properties:
total_count:
type: integer
format: int32
description: 该用户下所有使用租户的总数量
example: 1
minimum: 1
maximum: 2147483647
count:
type: integer
format: int32
description: 该用户下查询出的所有使用租户的数量
example: 1
minimum: 1
maximum: 2147483647
origins:
items:
$ref: '#/definitions/origininfo'
description: 租户名,无实际用处,仅用于标识当前项目id
type: array
ListSupportRegions:
type: object
description: 后台支持的region
properties:
count:
type: integer
format: int32
description: 支持的region数量
example: 1
minimum: 1
maximum: 2147483647
regions:
description: 支持的region数组
minItems: 0
maxItems: 100
items:
type: string
type: array
LoginResponse:
type: object
properties:
username:
type: string
description: 当前登录用户
example: user1
id:
type: string
description: 用户id
Auth_Token:
type: string
description: 登录后生成的认证token
example: eyJhbGciOi*************XVCJ9
Activation:
type: integer
format: int32
description: 激活状态,-1冻结,0未激活,-1激活
Usertype:
type: string
description: 用户类型,0普通用户,9管理员
total_res_count:
type: string
description: 用户拥有的租户数量
ResConfList:
type: object
properties:
total:
type: integer
format: int32
description: 资源信息条数
example: 1
count:
type: integer
format: int32
description: 显示信息条数
res_conf_list:
type: array
items:
$ref: '#/definitions/ResConfig'
ChangePassBody:
type: object
required:
- username
- oldPassword
- newPassword
properties:
username:
type: string
description: 用户名
example: user1
oldPassword:
type: string
description: 旧密码,RSA加密
example: '******************'
newPassword:
type: string
description: 新密码,RSA加密
example: '******************'
LoginParam:
type: object
required:
- username
- password
properties:
username:
type: string
description: 登录用户名,英文字母开头,包含字母和数字
example: user1
minLength: 4
maxLength: 31
password:
type: string
description: 登录密码(RSA加密)
example: '********************************'
ModifyResConfigBody:
type: object
description: 使用租户的信息为配套使用,需要同时修改
required:
- id
- domain_name
- project_id
properties:
id:
type: string
description: 资源配置id,uuid格式,可通过获取所有租户配置获得
example: c0544f73-bce0-11ed-991f-fa163ecd2502
domain_name:
type: string
description: 租户名称
example: ''
maxLength: 64
project_id:
type: string
description: 华为云项目id
example: ''
maxLength: 64
GetUserInfo:
type: object
properties:
id:
type: string
description: 用户id,uuid格式,全局唯一
example: 302afed3-bcb6-11ed-9295-6805cab2638d
username:
type: string
description: 用户名
example: user1
email:
type: string
description: 邮箱
example: user1@demo.com
last_login:
type: string
description: 最近登陆时间,UTC时间格式2023-03-08T09:57:09Z
activation:
type: integer
format: int32
description: 激活状态,-1冻结,0未激活,1激活
user_type:
type: integer
format: int32
description: 用户类型,0普通用户,9管理员
total_res_number:
type: integer
format: int32
description: 用户拥有的租户数量
ReviseUser:
type: object
properties:
id:
type: string
description: 用户id
example: b3b22b1e***************03faa
username:
type: string
description: 要修改的用户名
example: user1
email:
type: string
description: 邮箱
example: '*******'
phone:
type: string
description: 电话
example: 13800000000
activation:
type: integer
format: int32
description: 激活状态
required:
- id
UserReviseInfoBody:
type: object
properties:
email:
type: string
description: 邮箱
example: user1@demo.com
phone:
type: string
description: 电话
example: 13000000000
UserImageResponse:
type: object
description: 获取资源账号特定区域私有镜像列表 响应体
required:
- count
- image_list
- version
properties:
count:
type: string
image_list:
type: array
items:
$ref: '#/definitions/image'
version:
type: string
description: IMS私有镜像 操作系统及版本
image:
type: object
required:
- image_id
- image_name
properties:
image_id:
type: string
description: IMS私有镜像id
image_name:
type: string
description: IMS私有镜像name 会重复
CreateBuildByImageRequest:
type: object
description: 创建应用包(直接绑定镜像)请求体
required:
- name
- version
- region
- image_id
- build_type
properties:
name:
type: string
description: 应用包名 字母开头 允许字母数字下划线 中划线
minLength: 2
maxLength: 50
pattern: ^[A-Za-z][\dA-Za-z\_\-]{1,49}$
description:
type: string
description: 描述
minLength: 1
maxLength: 100
operating_system:
type: string
description: 操作系统
minLength: 1
maxLength: 50
version:
type: string
description: 版本号
minLength: 1
maxLength: 50
region:
type: string
description: 您的镜像需要打包到哪个region?
minLength: 1
maxLength: 50
image_id:
type: string
description: IMS私有镜像id/SWR私有镜像id
build_type:
type: string
description: one of POD VM
BuildMsg:
type: object
properties:
build:
$ref: '#/definitions/DaoBuild'
fleet_list:
$ref: '#/definitions/FleetByBuildList'
description: 应用包详情及关联的fleet基本信息
required:
- build
- fleet_list
FleetByBuild:
type: object
description: build关联的fleet基本信息
properties:
fleet_id:
type: string
fleet_name:
type: string
fleet_state:
type: string
description: fleet状态,会过滤掉terminated状态
creation_time:
type: string
FleetByBuildList:
type: object
description: build关联的fleet基本信息 列表
properties:
count:
type: string
fleet:
type: array
items:
$ref: '#/definitions/FleetByBuild'
required:
- count
- fleet
InsertResConfResp:
type: object
properties:
id:
type: string
description: 租户资源id
ResConfig:
description: 租户信息
$ref: '#/definitions/ResConfig'
vpc:
type: object
required:
- vpc_id
- vpc_name
properties:
vpc_id:
type: string
vpc_name:
type: string
subnet:
type: object
required:
- subnet_id
- subnet_name
properties:
subnet_id:
type: string
subnet_name:
type: string
UserVpcResponse:
type: object
description: 获取资源账号特定区域vpc列表 响应体
required:
- count
- vpc_list
properties:
count:
type: string
vpc_list:
type: array
items:
$ref: '#/definitions/vpc'
UserSubnetResponse:
type: object
description: 获取资源账号特定区域子网列表 响应体
required:
- count
- subnet_list
properties:
count:
type: string
subnet_list:
type: array
items:
$ref: '#/definitions/subnet'
LTS_Config:
type: object
required:
- lts_access_config_name
- log_group_id
- lts_log_path
properties:
lts_access_config_name:
type: string
minLength: 1
maxLength: 64
description: 日志接入名称,在所有日志接入中唯一
example: log_access_config_name_demo
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
lts_log_path:
type: array
items:
type: string
description: 日志接入读取路径
example: '["/root/log","/root/err_log"]'
CreateAccessConfig:
type: object
required:
- fleet_id
- lts_config
properties:
fleet_id:
type: string
description: Fleetid,应用进程队列id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
lts_config:
description: 日志接入配置
$ref: '#/definitions/LTS_Config'
description:
type: string
description: 描述
example: demo
CreateAccessConfigResp:
type: object
properties:
id:
type: string
minLength: 32
maxLength: 36
description: 日志接入配置id,uuid格式
example: 587a76e1-ba5a-11ed-bccf-84a93e8b1644
fleet_id:
type: string
minLength: 32
maxLength: 36
description: Fleetid,应用进程队列id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
log_stream_id:
type: string
minLength: 32
maxLength: 36
description: 日志流id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
log_stream_name:
type: string
minLength: 1
maxLength: 64
description: 日志流名称
example: log_stream_name_demo
host_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
host_group_name:
type: string
minLength: 1
maxLength: 64
description: 日志组名称
example: log_group_name_demo
log_config_path:
type: array
items:
type: string
description: 日志接入路径
example: /root/log
access_config_name:
type: string
description: 日志接入名称
example: log_access_config_name_demo
access_config_id:
type: string
minLength: 32
maxLength: 36
description: 日志接入id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
description:
type: string
description: 描述
example: demo
AccessConfigInfo:
type: object
properties:
access_config_name:
type: string
description: 日志接入名称
access_config_id:
type: string
minLength: 32
maxLength: 36
description: 日志接入id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
host_group_id_list:
type: string
minLength: 32
maxLength: 36
description: 主机组id
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
log_stream_name:
type: string
minLength: 32
maxLength: 36
description: 日志流名称
example: log_stream_name_demo
log_stream_id:
type: string
minLength: 32
maxLength: 36
description: 日志流id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
log_stream_link:
type: string
description: 日志流跳转链接,可直接跳转LTS控制台查看
example: https://console.huaweiyun.com
log_config_path:
type: string
description: 日志接入配置路径
example: /root/log
obs_transfer_path:
type: string
description: obs转储路径
example: /bucket/test/LogTank
obs_transfer_path_link:
type: string
description: obs转储链接,可跳转obs桶查看转储日志
example: https://console.huaweicloud.com
create_time:
type: string
format: date-time
description: 创建时间
description:
type: string
description: 描述
example: demo
ListAccessConfig:
type: object
properties:
total:
type: integer
format: int32
description: 日志接入总数
count:
type: string
description: 当前页日志接入数量
access_config:
type: array
items:
$ref: '#/definitions/AccessConfigInfo'
description: 日志接入列表
UpdateAccessConfig:
type: object
required:
- access_config_id
properties:
access_config_id:
type: string
minLength: 32
maxLength: 36
description: 日志接入id
example: f1727a22-9c57-48d7-aaa2-d6f6892c57a7
description:
type: string
description: 描述
example: description test
CreateTransfer:
type: object
required:
- log_group_id
- log_stream_id
- transfer_info
properties:
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id
example: log_group_name_demo
log_stream_id:
type: string
minLength: 32
maxLength: 36
description: 日志流id
example: c5b59698-bcaf-11ed-bd4b-fa163ecd2502
transfer_info:
description: 日志转储配置详情
$ref: '#/definitions/CreateTransferInfo'
description:
type: string
minLength: 32
maxLength: 36
description: 描述
example: demo
CreateTransferInfo:
type: object
required:
- obs_bucket_name
- obs_period
- obs_transfer_path
properties:
obs_bucket_name:
type: string
minLength: 1
maxLength: 64
description: obs桶名
example: obs_bucket_name_demo
obs_period:
type: string
description: 枚举值,2min,5min, 30min,1hour,3hour,6hour,12hour,默认值为2min
example: 2min
obs_transfer_path:
type: string
description: 转储obs路径前缀,系统将自动拼接成:OBS桶名/转储前缀/Y/M/D的格式,支持英文字母数字和“-”
minLength: 1
maxLength: 64
example: demo-test
CreateTransferResp:
type: object
properties:
log_group_id:
type: string
description: 日志组id,uuid格式
example: 260c57a6-bc9b-11ed-8130-fa163ecd2586
log_group_name:
type: string
description: 日志组名称
example: log_group_name_demo
log_stream_id:
type: string
minLength: 32
maxLength: 36
description: 日志流id,uuid格式
example: 7c8b1674-bcaf-11ed-84a2-6805cab2638d
log_stream_name:
type: string
minLength: 1
maxLength: 64
description: 日志流名称
example: log_stream_name_demo
log_transfer_id:
type: string
minLength: 32
maxLength: 36
description: 日志流id,uuid格式
example: 7c8b1674-bcaf-11ed-84a2-6805cab2638d
transfer_info:
$ref: '#/definitions/CreateTransferInfo'
QureyTransferInfo:
type: object
properties:
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id,uuid格式,全局唯一
example: 25cc4d27-ba5d-11ed-a7c2-fa163ecd2586
log_stream_id:
type: string
minLength: 32
maxLength: 36
description: 日志流id,uuid格式,全局唯一
example: 25cc4d27-ba5d-11ed-a7c2-fa163ecd2586
log_transfer_id:
type: string
minLength: 32
maxLength: 36
description: 日志转储id,uuid格式,全局唯一
example: 25cc4d27-ba5d-11ed-a7c2-fa163ecd2586
transfer_info:
items:
$ref: '#/definitions/TransferInfo'
type: array
description: 日志转储信息
ListTransferResp:
type: object
properties:
total:
type: integer
format: int32
description: 转储总数
count:
type: integer
format: int32
description: 当前查询数
log_transfer_list:
type: array
items:
$ref: '#/definitions/QureyTransferInfo'
CreateLogGroupReq:
type: object
required:
- log_group_name
- ttl_in_day
properties:
log_group_name:
type: string
minLength: 1
maxLength: 64
description: 日志组名称
example: log_group_name_test
ttl_in_day:
type: integer
format: int32
description: 日志保留时间
example: 7
minimum: 1
maximum: 365
Create:
type: object
properties:
log_group_name:
type: string
description: 日志组名称
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id
ttl_in_day:
type: integer
format: int32
description: 日志保留时间
CreateLogGroupResp:
type: object
properties:
log_group_name:
type: string
description: 日志组名称
example: log_group_name_demo
log_group_id:
type: string
description: 日志组id,uuid格式,全局唯一
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
ttl_in_day:
type: integer
format: int32
description: 日志在云日志服务中的保留时间
example: 7
associated_alias:
type: object
required:
- alias_name
- alias_id
- status
properties:
alias_name:
type: string
alias_id:
type: string
status:
type: string
ListLogGroup:
type: object
properties:
total:
type: integer
format: int32
description: 日志组数量
log_groups:
type: array
items:
$ref: '#/definitions/LogGroupInfo'
description: 日志组列表
LogGroupInfo:
type: object
properties:
log_group_name:
type: string
minLength: 32
maxLength: 36
description: 日志组名称
example: log_group_name_demo
log_group_id:
type: string
minLength: 32
maxLength: 36
description: 日志组id,uuid格式,全局唯一
example: c5b59698-bcaf-11ed-bd4b-fa163ecd2502
creation_time:
type: string
description: 日志组创建时间
ttl_in_days:
type: string
description: 日志保留时间
TransferInfo:
type: object
properties:
obs_period_unit:
type: string
description: obs转储周期时间单位,枚举值,为min或hour
example: min
obs_period:
type: integer
format: int32
description: obs转储周期时间
example: 2
obs_bucket_name:
type: string
description: obs转储桶名
example: bucket_name_demo
obs_transfer_path:
type: string
description: obs转储路径
example: /root/log
ScalingGroupCapacity:
type: object
properties:
min_instance_number:
type: integer
format: int32
description: 伸缩组内最小实例数(台),默认1台
example: 1
max_instance_number:
type: integer
format: int32
description: 伸缩组内最大实例数(台),弹性伸缩组限制最大300台实例,默认1台
example: 1
ListSupportImageBody:
type: object
description: 创建应用包时 支持选择的公共操作系统
properties:
count:
type: integer
format: int32
description: 总数
support_image_list:
type: array
items:
type: string
description: 支持的公共镜像列表
ResourceSpecificationRequest:
type: object
required:
- instance_type
- name
- region
- resource_specification
- flavor
properties:
instance_type:
type: string
description: 实例类型,支持VM,POD,VM为ECS,POD为容器
name:
type: string
example: test
description: 实例规格的别名
minLength: 1
maxLength: 1024
region:
type: string
example: cn-north-4
description: 应用进程队列所在的region
minLength: 1
maxLength: 64
resource_specification:
type: string
example: scase_standard_2u4g
description: 实例规格;当instance_type为POD时,该项值为pod
minLength: 1
maxLength: 1024
flavor:
type: array
items:
type: string
minLength: 1
maxLength: 1024
example:
- Si2.large.2
- Si3.large.2
- ac7.large.2
- c3.large.2
description: |-
实例规格的具体详情;
当instance_type为POD时,必须满足如下条件:
(1)flavor数组长度为1
(2)必须按照"{\\"cpu\\":1,\\"memory\\":2}"给定字符串
(3)cpu的区间为[1,64],memory的区间为[2,512]
(4)memory和cpu比值的区间为[2,8]
minItems: 1
maxItems: 10
ResponseForListResourceSpecification:
type: object
required:
- count
- resource_specifications
properties:
count:
type: integer
format: int32
example: 1
description: 实例规格数量
resource_specifications:
items:
properties:
instance_type:
type: string
description: 实例类型
id:
type: string
example: 9158fb9b-3cc6-42bc-a995-98998fc654fa
description: 实例规格id
region:
type: string
example: cn-north-7
description: 应用进程队列所在的region
name:
type: string
example: 111
description: 实例规格所起别名
resource_specification:
type: string
example: scase_standard_2u4g
description: 实例规格
flavor:
type: array
items:
type: string
example:
- air7.28xlarge.4
- Si2.large.2
- Si3.large.2
- ac7.large.2
- c3.large.2
description: 实例规格详情
creation_time:
type: string
example: '2023-05-17T02:46:49+08:00'
description: 创建时间
update_time:
type: string
fleet_count:
type: string
associated_fleets:
type: array
items:
properties:
name:
type: string
fleet_id:
type: string
state:
type: string
instance_count:
type: integer
format: int32
process_count:
type: integer
format: int32
max_server_session_count:
type: integer
format: int32
creation_time:
type: string
description: 实例规格相关参数
type: array
UpdateResourceSpecificationRequest:
type: object
required:
- id
- region
- new_name
- resource_specification
- flavor
properties:
id:
type: string
example: 5a9c7fb3-f3b2-11ed-895f-286ed488f081
minLength: 1
maxLength: 128
region:
type: string
example: cn-north-7
minLength: 1
maxLength: 128
new_name:
type: string
example: test-666
minLength: 1
maxLength: 1024
resource_specification:
type: string
example: scase_standard_2u4g
minLength: 1
maxLength: 1024
description: 实例规格;当instance_type为POD时,该项值为pod
flavor:
type: array
items:
minLength: 1
maxLength: 1024
type: string
example:
- Si2.large.2
- Si3.large.2
- ac7.large.2
- c3.large.2
minItems: 1
maxItems: 10
description: |-
实例规格的具体详情;
当instance_type为POD时,必须满足如下条件:
(1)flavor数组长度为1
(2)必须按照"{\"cpu\":1,\"memory\":2}"给定字符串
(3)cpu的区间为[1,64],memory的区间为[2,512]
(4)memory和cpu比值的区间为[2,8]
security_group:
type: object
properties:
security_group_id:
type: string
example: '"50119d3d-f960-4d4c-aeba-483f9488844d"'
security_group_name:
type: string
example: '"50119d3d-f960-4d4c-aeba-483f9488844d"'
example: ''
security_group_copy:
type: object
properties:
security_group_id:
type: string
example: '"50119d3d-f960-4d4c-aeba-483f9488844d"'
security_group_name:
type: string
example: '"50119d3d-f960-4d4c-aeba-483f9488844d"'
example: ''
ResponseForCreateResourceSpecification:
type: object
properties:
resource_specifications:
properties:
instance_type:
type: string
description: 实例类型,支持VM,POD,VM为ECS,POD为容器
id:
type: string
example: 9158fb9b-3cc6-42bc-a995-98998fc654fa
description: 实例ID
region:
type: string
example: cn-north-7
name:
type: integer
format: int32
example: 111
resource_specification:
type: string
example: scase_standard_2u4g
description: 实例规格
flavor:
type: array
items:
type: string
example:
- air7.28xlarge.4
- Si2.large.2
- Si3.large.2
- ac7.large.2
- c3.large.2
description: 当instance_type为POD时,长度为1,且按照"{\\"cpu\\":1,\\"memory\\":2}"给定字符串
creation_time:
type: string
example: '2023-05-17T02:46:49+08:00'
description: 创建时间,形如2023-08-09T06:45:40Z
update_time:
type: string
description: 更新时间,形如2023-08-09T06:45:40Z
buildbandwidth:
type: object
description: 应用包创建临时EIP参数--带宽大小与计费方式(按带宽/按流量)
properties:
size:
type: integer
format: int32
description: 大小 1~2000
minimum: 1
maximum: 2000
charging_mode:
type: string
description: 枚举 bandwidth , traffic
required:
- size
- charging_mode
associated_fleets:
type: object
properties:
associated_fleets:
items:
properties:
name:
type: string
example: auxproxy-01-0523
fleet_id:
type: string
example: b4e3f48b-f946-11ed-86f2-fa163ecd2586
state:
type: string
example: ACTIVE
instance_count:
type: integer
format: int32
example: 4
process_count:
type: integer
format: int32
example: 50
max_server_session_count:
type: integer
format: int32
example: 20
creation_time:
type: string
example: '2023-05-23T08:49:20+08:00'
type: array
CreateEventRequest:
type: object
required:
- trace_name
- resource_type
- trace_service
- trace_state
- event_type
properties:
name:
type: string
minLength: 1
maxLength: 64
description: 事件名,主要是触发事件的关键函数
example: DispatchProcess
resource_type:
type: string
example: process
description: >-
事件涉及的资源类型
* user:用户
* fleet: 应用进程队列
* instance: 实例
* process: 进程
* session: 会话
* build: 应用包
* request: 网络请求
minLength: 0
maxLength: 32
enum:
- user
- fleet
- instance
- process
- session
- request
- build
trace_service:
type: string
example: appgateway
description: >-
事件涉及的服务组件
* fleetmanager
* appgateway
* aass
* auxproxy
minLength: 0
maxLength: 32
enum:
- fleetmanager
- appgateway
- aass
- auxproxy
resource_id:
type: string
minLength: 0
maxLength: 64
description: 事件涉及的资源id
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
resource_name:
type: string
minLength: 0
maxLength: 64
description: 事件涉及的资源名
example: resource name
trace_state:
type: string
example: WARNING
description: >-
事件的等级
* NORMAL
* WARNING
* INCIDENT
minLength: 0
maxLength: 32
enum:
- NORMAL
- WARNING
- INCIDENT
event_type:
type: string
example: data
description: >-
事件的类型
* data
* manager
minLength: 0
maxLength: 32
enum:
- data
- manager
source_ip:
type: string
minLength: 0
maxLength: 64
description: 事件来源的ip
example: 10.150.0.1
details:
type: string
minLength: 0
description: 事件来源的细节
example: this is details
message:
type: string
minLength: 0
maxLength: 490
description: 短信或邮件内容,当事件的等级为INCIDENT时,会自动触发消息发布
example: this is a message
ShowEventResponse:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 64
description: 事件id
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
name:
type: string
minLength: 1
maxLength: 64
description: 事件名,主要是触发事件的关键函数
example: DispatchProcess
resource_type:
type: string
example: process
description: >-
事件涉及的资源类型
* user:用户
* fleet: 应用进程队列
* instance: 实例
* process: 进程
* session: 会话
* build: 应用包
* request: 网络请求
minLength: 0
maxLength: 32
enum:
- user
- fleet
- instance
- process
- session
- build
- request
trace_service:
type: string
example: appgateway
description: >-
事件涉及的服务组件
* fleetmanager
* appgateway
* aass
* auxproxy
minLength: 0
maxLength: 32
enum:
- fleetmanager
- appgateway
- aass
- auxproxy
resource_id:
type: string
minLength: 0
maxLength: 64
description: 事件涉及的资源id
example: 4e2db2de-8809-435c-8a3a-2a614c0947f0
resource_name:
type: string
minLength: 0
maxLength: 64
description: 事件涉及的资源名
example: resource name
trace_state:
type: string
example: WARNING
description: >-
事件的等级
* NORMAL
* WARNING
* INCIDENT
minLength: 0
maxLength: 32
enum:
- NORMAL
- WARNING
- INCIDENT
event_type:
type: string
example: data
description: >-
事件的类型
* data
* manager
minLength: 0
maxLength: 32
enum:
- data
- manager
source_ip:
type: string
minLength: 0
maxLength: 64
description: 事件来源的ip
example: 10.150.0.1
details:
type: string
minLength: 0
description: 事件来源的细节
example: this is details
message:
type: string
minLength: 0
maxLength: 490
description: 短信或邮件内容,当事件的等级为INCIDENT时,会自动触发消息发布
example: this is a message
notice_state:
type: string
minLength: 0
description: 短信或邮件内容,自动触发消息发布的状态,若事件等级为NORMAL或WARNING,该字段为空
example: success to publish message as a457289aa96d4604aeb1fe887d122961
record_time:
type: string
minLength: 0
description: 时间的记录时间
example: '2023-06-13T14:11:20Z'
ListEventsResp:
properties:
total_count:
type: integer
format: int32
description: 事件的总数量
minimum: 1
maximum: 2147483647
example: 1
count:
type: integer
format: int32
description: 查询出的事件数量
minimum: 0
maximum: 2147483647
example: 1
events:
type: array
description: 事件列表
minItems: 0
maxItems: 100
items:
$ref: '#/definitions/ShowEventResponse'
CreateTopicRequest:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 255
description: 主题的名称
example: test-topic-name
enterprise_project_id:
type: string
minLength: 0
maxLength: 64
description: 企业项目ID, 默认为 0(default)
example: '0'
notice_trace_status:
type: array
items:
type: string
example: INCIDENT
example: INCIDENT
description: >-
根据事件的级别决定是否短信或邮件通知,非重
* NORMAL
* WARNING
* INCIDENT
enum:
- NORMAL
- WARNING
- INCIDENT
ShowTopicResp:
type: object
properties:
name:
type: string
minLength: 0
maxLength: 256
description: 主题的名称
example: test-topic-name
topic_urn:
type: string
minLength: 0
maxLength: 256
description: 主题的urn
example: urn:smn:cn-north-7:e537e265f1c94a2ea61e0c26794bb964:test-aass
display_name:
type: string
minLength: 0
maxLength: 192
description: 显示的名称,该字段不生效,默认为 HWC-SAC-GameFlexMatch
example: HWC-SAC-GameFlexMatch
enterprise_project_id:
type: string
minLength: 0
maxLength: 64
description: 企业项目ID, 默认为 0(default)
example: '0'
subscription_count:
type: integer
minLength: 0
maxLength: 50
description: 订阅者的数量
example: 1
subscriptions:
type: array
description: 订阅者列表
minItems: 0
maxItems: 50
items:
$ref: '#/definitions/Subcription'
state_and_reason:
type: string
minLength: 0
maxLength: 1024
description: 主题创建的状态以及原因
example: Success
notice_trace_status:
type: string
example: INCIDENT
description: >-
根据事件的级别决定是否短信或邮件通知,非重
* NORMAL
* WARNING
* INCIDENT
minLength: 0
maxLength: 32
enum:
- NORMAL
- WARNING
- INCIDENT
creation_time:
type: string
minLength: 0
description: 主题的创建时间
example: '2023-06-13T14:11:20Z'
Subcription:
type: object
properties:
protocol:
type: string
minLength: 0
maxLength: 256
description: 通知的协议,当前只支持email(邮件)和sms(短信)
example: email
endpoint:
type: string
minLength: 0
maxLength: 256
description: 终端节点,协议为email的时候为邮箱地址,为sms的时候为电话号码
example: test@huawei.com
subcription_urn:
type: string
minLength: 0
maxLength: 256
description: 订阅者的urn
example: urn:smn:cn-north-7:e537e265f1c94a2ea61e0c26794bb964:test-aass:c24cf8ca07ce4a3ea36172bf0860495a
remark:
type: string
minLength: 0
maxLength: 256
description: 订阅者的备注
example: 运维
status:
type: string
minLength: 0
maxLength: 256
description: 订阅者是否确认订阅, 0:未确认 1:已确认 2:不需要确认 3:已取消确认 4:已经删除
example: 0
AddSubscriptionRequest:
type: object
properties:
protocol:
type: string
minLength: 0
maxLength: 256
description: 通知的协议,当前只支持email(邮件)和sms(短信)
example: email
enum:
- email
- sms
endpoint:
type: string
minLength: 0
maxLength: 256
description: 终端节点,协议为email的时候为邮箱地址,为sms的时候为电话号码
example: test@huawei.com
remark:
type: string
minLength: 0
maxLength: 256
description: 订阅者的备注
example: 运维
UpdateTopicRequest:
type: object
properties:
notice_trace_status:
type: string
example: INCIDENT
description: >-
根据事件的级别决定是否短信或邮件通知,非重
* NORMAL
* WARNING
* INCIDENT
minLength: 0
maxLength: 32
enum:
- NORMAL
- WARNING
- INCIDENT
AvaliableZone:
type: object
properties:
available_zone_name:
type: string
description: 可用区名称
example: 可用区1
available_zone_id:
type: string
description: 可用区id
example: cn-north-4a
CreateFleetWithCCIRequestBody:
description: 创建应用进程队列请求体
properties:
intance_type:
type: string
description: 实例类型,只支持vm,cci
name:
type: string
description: 应用进程队列的名称. 可以不唯一.
minLength: 1
maxLength: 1024
example: MyDemo
description:
type: string
description: 应用进程队列描述
minLength: 1
maxLength: 1024
example: this is a demo
build_id:
type: string
description: 应用包id,创建后不支持修改
example: build-52d872a5-acd3-11ec-a7e0-6805cab276a1
minLength: 1
maxLength: 64
region:
type: string
default: cn-north-4
example: cn-north-4
description: |-
应用进程队列所在的region,只支持北京四region
* cn-north-4: 北京四
enum:
- cn-north-4
public_ip:
$ref: '#/definitions/PublicIp'
description: CCI的IP配置
enterprise_project_id:
type: string
description: fleet所在的企业项目,默认为服务部署时所指定的企业项目,若服务部署时没有指定,则为默认企业项目
default: 0
example: 238012fd-0649-4fc8-bb89-bf6fc8b38d72
vpc_id:
type: string
description: VPC id
default: 52d872a5-acd3-11ec-a7e0-6805cab276a1
example: 52d872a5-acd3-11ec-a7e0-6805cab276a1
subnet_id:
type: string
description: 子网id
default: 52d872a5-acd3-11ec-a7e0-6805cab276a1
example: 52d872a5-acd3-11ec-a7e0-6805cab276a1
server_session_protection_policy:
type: string
description: >-
服务服务器会话保护策略
* NO_PROTECTION: 不保护,缩容时如果有会话在实例上运行,直接缩容
* FULL_PROTECTION: 完全保护,缩容时如果有会话在实例上运行,等待会话结束再缩容
* TIME_LIMIT_PROTECTION:
限时保护,缩容时如果有会话在实例上运行,等待一定时间后缩容,等待时间由server_session_protection_time_limit_minutes指定
example: NO_PROTECTION
enum:
- NO_PROTECTION
- FULL_PROTECTION
- TIME_LIMIT_PROTECTION
server_session_protection_time_limit_minutes:
type: integer
format: int32
description: server_session_protection_policy字段为TimeLimitProtection时有效,单位分钟,最大值不超过一天
minimum: 5
maximum: 1440
default: 5
example: 5
resource_creation_limit_policy:
$ref: '#/definitions/ResourceCreationLimitPolicy'
description: 对客户端在指定时间内可以创建的服务器会话数量进行限制的策略。通过这个策略,你可以控制客户端消耗可用资源的能力。
runtime_configuration:
$ref: '#/definitions/RuntimeConfiguration'
description: 应用进程队列的运行时配置信息
inbound_permissions:
type: array
minItems: 1
maxItems: 50
description: 访问配置,即允许外部访问应用进程的IP地址和端口描述
items:
$ref: '#/definitions/IpPermission'
instance_tags:
type: array
description: 实例标签数组
minItems: 0
maxItems: 10
items:
$ref: '#/definitions/InstanceTag'
scaling_group_capacity:
description: 伸缩组实例初始容量参数
$ref: '#/definitions/ScalingGroupCapacity'
resource_specification_id:
type: string
description: 实力规格id
security_group_ids:
type: array
items:
type: string
description: 安全组id
available_zones:
type: array
description: 创建实例资源的可用区,可通过接口获取,为空时随机选择可用区(推荐),不为空则按照可用区优先顺序创建
example:
- cn-north-4a
items:
type: string
minItems: 0
maxItems: 10
required:
- intance_type
- name
- build_id
- vpc_id
- runtime_configuration
- inbound_permissions
type: object
BindResConf:
type: object
description: 绑定已有租户信息结构体
required:
- user_id
- ori_project_id
- domain_name
properties:
user_id:
type: string
description: 目标用户id
ori_project_id:
type: string
description: 绑定租户标识
domain_name:
type: string
description: 新增租户名称
RelatedFleetListResp:
type: object
properties:
Count:
type: integer
format: int32
description: 绑定的fleet数量
AssociatedFleetOfPolicyList:
type: array
items:
$ref: '#/definitions/AssociatedFleetOfPolicyList'
description: 绑定的Fleet详情
AssociatedFleetOfPolicyList:
type: object
properties:
name:
type: string
description: fleet名称
fleet_id:
type: string
description: fleet_id
state:
type: string
description: fleet状态
intance_count:
type: integer
format: int32
description: 实例数量
process_count:
type: integer
format: int32
description: 进程数量
server_session_count:
type: integer
format: int32
description: 当前会话数
max_server_session_count:
type: integer
format: int32
description: 最大会话数
AssociatedPolicyOfFleet:
type: object
properties:
id:
type: string
description: 伸缩策略id
name:
type: string
description: 策略名称
policy_type:
type: string
description: 策略类型
target_based_configuration:
$ref: '#/definitions/TargetBasedConfiguration'
origininfo:
type: object
required:
- domain_name
- ori_project_id
- project_id
- region
properties:
domain_name:
type: string
ori_project_id:
type: string
project_id:
type: string
region:
type: string
ResourceMessage:
type: object
properties:
service:
type: string
example: metaspace-fleetmanager
dim_name:
type: string
example: instance_id
value:
type: string
example: 1e03d533-1453-4592-94e1-ec7c68a8783a
ResourceMonitoringReq:
type: object
properties:
metrics:
items:
properties:
namespace:
type: string
example: SYS.ECS
metric_name:
type: string
example: cpu_util
dimensions:
items:
properties:
name:
type: string
example: instance_id
value:
type: string
example: 4270ff17-aba3-4138-89fa-820594c39755
type: array
type: array
period:
type: string
example: 1
filter:
type: string
example: 1
from:
type: integer
format: int32
example: 1607146998177
to:
type: integer
format: int32
example: 1607146998177
BatchListMetricDataResponse:
type: object
properties:
metrics:
items:
properties:
unit:
type: string
example: Ratio
datapoints:
items:
properties:
sum:
type: number
format: float
example: 0.07
timestamp:
type: integer
format: int32
example: 1556625628000
type: array
namespace:
type: string
example: SYS.RDS
dimensions:
items:
properties:
name:
type: string
example: rds_cluster_id
value:
type: string
example: 3c8cc15614ab46f5b8743317555e0de2in01
type: array
metric_name:
type: string
example: rds021_myisam_buf_usage
type: array
ResponseForShowResourceSpecification:
type: object
properties:
instance_type:
type: string
example: POD
description: 实例类型,支持VM,POD,VM为ECS,POD为容器
id:
type: string
example: aedf809d-1e1b-4935-a217-e4d0483ee1ff
description: 实例ID
region:
type: string
example: ''
description: 所属区域
name:
type: string
example: xxxxxx
description: 实例规格组名称
resource_specification:
type: string
example: pod_2u4g
description: 实例规格;当instance_type为POD时,该项值为pod
flavor:
type: array
items:
type: string
example:
- '{"cpu":2'
- '"memory":4}'
description: |-
实例规格的具体详情;
当instance_type为POD时,必须满足如下条件:
(1)flavor数组长度为1
(2)按照"{\"cpu\":1,\"memory\":2}"给定字符串
(3)cpu的区间为[1,64],memory的区间为[2,512]
(4)memory和cpu比值的区间为[2,8]
creation_time:
type: string
example: '2023-08-09T06:45:41Z'
description: 创建时间,UTC字符串
update_time:
type: string
example: '2023-08-09T07:14:49Z'
description: 更新时间,UTC字符串
fleet_count:
type: integer
format: int32
example: 0
description: 关联Fleet数量
associated_fleets:
type: string
example: null
description: 关联Fleet详细信息
ListSupportDockerImageBody:
type: object
description: 创建应用包时 支持选择操作系统
properties:
count:
type: integer
format: int32
description: 总数
support_image_list:
type: array
items:
type: string
description: 支持的公共镜像列表
CreateSwrOrganization:
type: object
description: 创建SWR组织
required:
- region
- organization
properties:
region:
type: string
organization:
type: string
description: 组织名称 正则 ^[a-z][a-z0-9]{0,63}$
UserDockerImageResponse:
type: object
description: 获取SWR私有镜像
required:
- count
- docker_image_list
properties:
count:
type: string
docker_image_list:
type: array
items:
type: string
GetAllUserResp:
type: object
properties:
count:
type: integer
format: int32
description: 当前页面的用户数量
total:
type: integer
format: int32
description: 所有用户数量
users:
type: array
items:
$ref: '#/definitions/GetUserInfo'
description: 用户详情