dragonflyoss
/
dragonfly
mirror of https://github.com/dragonflyoss/dragonfly.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dragonfly/docs/zh-CN/api/api.md

36 KiB
Raw Blame History

Dragonfly Manager

概览

Dragonfly Manager Server

版本信息

版本 : 1.0.0

许可信息

许可证 : Apache 2.0
服务条款 : null

URI scheme

域名 : localhost:8080
基础路径 : /api/v1

路径

Create CDNCluster

POST /api/v1/cdn-clusters

说明

create by json config

参数

类型 名称 说明 类型
Body CDNCluster
必填		 DNCluster types.CreateCDNClusterRequest

响应

HTTP代码 说明 类型
200 OK model.CDNCluster
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Get CDNClusters

GET /api/v1/cdn-clusters

说明

Get CDNClusters

参数

类型 名称 说明 类型 默认值
Query page
必填		 current page integer 0
Query per_page
必填		 return max item count, default 10, max 50 integer 10

响应

HTTP代码 说明 类型
200 OK < model.CDNCluster > array
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Get CDNCluster

GET /api/v1/cdn-clusters/{id}

说明

Get CDNCluster by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK model.CDNCluster
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Destroy CDNCluster

DELETE /api/v1/cdn-clusters/{id}

说明

Destroy by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Update CDNCluster

PATCH /api/v1/cdn-clusters/{id}

说明

Update by json config

参数

类型 名称 说明 类型
Path id
必填		 id string
Body CDNCluster
必填		 CDNCluster types.UpdateCDNClusterRequest

响应

HTTP代码 说明 类型
200 OK model.CDNCluster
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Add Instance to CDNCluster

PUT /api/v1/cdn-clusters/{id}/cdns/{cdn_id}

说明

Add CDN to CDNCluster

参数

类型 名称 说明 类型
Path cdn_id
必填		 cdn id string
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Add SchedulerCluster to CDNCluster

PUT /api/v1/cdn-clusters/{id}/scheduler-clusters/{scheduler_cluster_id}

说明

Add SchedulerCluster to CDNCluster

参数

类型 名称 说明 类型
Path id
必填		 id string
Path scheduler_cluster_id
必填		 scheduler cluster id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDNCluster

Create CDN

POST /api/v1/cdns

说明

create by json config

参数

类型 名称 说明 类型
Body CDN
必填		 CDN types.CreateCDNRequest

响应

HTTP代码 说明 类型
200 OK model.CDN
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDN

Get CDNs

GET /api/v1/cdns

说明

Get CDNs

参数

类型 名称 说明 类型 默认值
Query page
必填		 current page integer 0
Query per_page
必填		 return max item count, default 10, max 50 integer 10

响应

HTTP代码 说明 类型
200 OK < model.CDN > array
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDN

Get CDN

GET /api/v1/cdns/{id}

说明

Get CDN by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK model.CDN
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDN

Destroy CDN

DELETE /api/v1/cdns/{id}

说明

Destroy by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDN

Update CDN

PATCH /api/v1/cdns/{id}

说明

Update by json config

参数

类型 名称 说明 类型
Path id
必填		 id string
Body CDN
必填		 CDN types.UpdateCDNRequest

响应

HTTP代码 说明 类型
200 OK model.CDN
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • CDN

Get Health

GET /api/v1/healthy

说明

Get app health

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Health

Create Oauth

POST /api/v1/oauth

说明

create by json config

参数

类型 名称 说明 类型
Body Oauth
必填		 Oauth types.CreateOauthRequest

响应

HTTP代码 说明 类型
200 OK model.Oauth
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Oauth

Get Oauths

GET /api/v1/oauth

说明

Get Oauths

参数

类型 名称 说明 类型 默认值
Query page
必填		 current page integer 0
Query per_page
必填		 return max item count, default 10, max 50 integer 10

响应

HTTP代码 说明 类型
200 OK < model.Oauth > array
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Oauth

Get Oauth

GET /api/v1/oauth/{id}

说明

Get Oauth by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK model.Oauth
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Oauth

Destroy Oauth

DELETE /api/v1/oauth/{id}

说明

Destroy by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Oauth

Update Oauth

PATCH /api/v1/oauth/{id}

说明

Update by json config

参数

类型 名称 说明 类型
Path id
必填		 id string
Body Oauth
必填		 Oauth types.UpdateOauthRequest

响应

HTTP代码 说明 类型
200 OK model.Oauth
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Oauth

Get Permissions

GET /api/v1/permissions

说明

Get Permissions

响应

HTTP代码 说明 类型
200 OK < rbac.Permission > array
400 无内容
500 无内容

生成

  • application/json

标签

  • Permission

Create Preheat

POST /api/v1/preheats

说明

create by json config

参数

类型 名称 说明 类型
Body CDN
必填		 Preheat types.CreatePreheatRequest

响应

HTTP代码 说明 类型
200 OK types.Preheat
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Preheat

Get Preheat

GET /api/v1/preheats/{id}

说明

Get Preheat by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK types.Preheat
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Preheat

Create Role

POST /api/v1/roles

说明

Create Role by json config

参数

类型 名称 说明 类型
Body Role
必填		 Role types.CreateRoleRequest

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Role

Get Roles

GET /api/v1/roles

说明

Get roles

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Role

Get Role

GET /api/v1/roles/:role

说明

Get Role

参数

类型 名称 说明 类型
Path role
必填		 role string

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Role

Destroy Role

DELETE /api/v1/roles/:role

说明

Destroy role by json config

参数

类型 名称 说明 类型
Path role
必填		 role string

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Role

Add Permission For Role

POST /api/v1/roles/:role/permissions

说明

Add Permission by json config

参数

类型 名称 说明 类型
Path role
必填		 role string
Body Permission
必填		 Permission types.AddPermissionForRoleRequest

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Role

Update Role

DELETE /api/v1/roles/:role/permissions

说明

Remove Role Permission by json config

参数

类型 名称 说明 类型
Path role
必填		 role string
Body Permission
必填		 Permission types.DeletePermissionForRoleRequest

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Role

Create SchedulerCluster

POST /api/v1/scheduler-clusters

说明

create by json config

参数

类型 名称 说明 类型
Body SchedulerCluster
必填		 SchedulerCluster types.CreateSchedulerClusterRequest

响应

HTTP代码 说明 类型
200 OK model.SchedulerCluster
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SchedulerCluster

Get SchedulerClusters

GET /api/v1/scheduler-clusters

说明

Get SchedulerClusters

参数

类型 名称 说明 类型 默认值
Query page
必填		 current page integer 0
Query per_page
必填		 return max item count, default 10, max 50 integer 10

响应

HTTP代码 说明 类型
200 OK < model.SchedulerCluster > array
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SchedulerCluster

Get SchedulerCluster

GET /api/v1/scheduler-clusters/{id}

说明

Get SchedulerCluster by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK model.SchedulerCluster
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SchedulerCluster

Destroy SchedulerCluster

DELETE /api/v1/scheduler-clusters/{id}

说明

Destroy by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SchedulerCluster

Update SchedulerCluster

PATCH /api/v1/scheduler-clusters/{id}

说明

Update by json config

参数

类型 名称 说明 类型
Path id
必填		 id string
Body SchedulerCluster
必填		 SchedulerCluster types.UpdateSchedulerClusterRequest

响应

HTTP代码 说明 类型
200 OK model.SchedulerCluster
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SchedulerCluster

Add Scheduler to schedulerCluster

PUT /api/v1/scheduler-clusters/{id}/schedulers/{scheduler_id}

说明

Add Scheduler to schedulerCluster

参数

类型 名称 说明 类型
Path id
必填		 id string
Path scheduler_id
必填		 scheduler id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SchedulerCluster

Create Scheduler

POST /api/v1/schedulers

说明

create by json config

参数

类型 名称 说明 类型
Body Scheduler
必填		 Scheduler types.CreateSchedulerRequest

响应

HTTP代码 说明 类型
200 OK model.Scheduler
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Scheduler

Get Schedulers

GET /api/v1/schedulers

说明

Get Schedulers

参数

类型 名称 说明 类型 默认值
Query page
必填		 current page integer 0
Query per_page
必填		 return max item count, default 10, max 50 integer 10

响应

HTTP代码 说明 类型
200 OK < model.Scheduler > array
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Scheduler

Get Scheduler

GET /api/v1/schedulers/{id}

说明

Get Scheduler by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK model.Scheduler
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Scheduler

Destroy Scheduler

DELETE /api/v1/schedulers/{id}

说明

Destroy by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Scheduler

Update Scheduler

PATCH /api/v1/schedulers/{id}

说明

Update by json config

参数

类型 名称 说明 类型
Path id
必填		 id string
Body Scheduler
必填		 Scheduler types.UpdateSchedulerRequest

响应

HTTP代码 说明 类型
200 OK model.Scheduler
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Scheduler

Create SecurityGroup

POST /api/v1/security-groups

说明

create by json config

参数

类型 名称 说明 类型
Body SecurityGroup
必填		 SecurityGroup types.CreateSecurityGroupRequest

响应

HTTP代码 说明 类型
200 OK model.SecurityGroup
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Get SecurityGroups

GET /api/v1/security-groups

说明

Get SecurityGroups

参数

类型 名称 说明 类型 默认值
Query page
必填		 current page integer 0
Query per_page
必填		 return max item count, default 10, max 50 integer 10

响应

HTTP代码 说明 类型
200 OK < model.SecurityGroup > array
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Get SecurityGroup

GET /api/v1/security-groups/{id}

说明

Get SecurityGroup by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK model.SecurityGroup
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Update SecurityGroup

PATCH /api/v1/security-groups/{id}

说明

Update by json config

参数

类型 名称 说明 类型
Path id
必填		 id string
Body SecurityGroup
必填		 SecurityGroup types.UpdateSecurityGroupRequest

响应

HTTP代码 说明 类型
200 OK model.SecurityGroup
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Add CDN to SecurityGroup

PUT /api/v1/security-groups/{id}/cdn-clusters/{cdn_cluster_id}

说明

Add CDN to SecurityGroup

参数

类型 名称 说明 类型
Path cdn_cluster_id
必填		 cdn cluster id string
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Add Scheduler to SecurityGroup

PUT /api/v1/security-groups/{id}/scheduler-clusters/{scheduler_cluster_id}

说明

Add Scheduler to SecurityGroup

参数

类型 名称 说明 类型
Path id
必填		 id string
Path scheduler_cluster_id
必填		 scheduler cluster id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Destroy SecurityGroup

DELETE /api/v1/securityGroups/{id}

说明

Destroy by id

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • SecurityGroup

Oauth Signin

GET /api/v1/user/signin/{name}

说明

oauth signin by json config

参数

类型 名称 说明 类型
Path name
必填		 name string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • User

Oauth Signin Callback

GET /api/v1/user/signin/{name}/callback

说明

oauth signin callback by json config

参数

类型 名称 说明 类型
Path name
必填		 name string
Query code
必填		 code string

响应

HTTP代码 类型
200 无内容
400 无内容
404 无内容
500 无内容

标签

  • Oauth

SignUp user

POST /api/v1/user/signup

说明

signup by json config

参数

类型 名称 说明 类型
Body User
必填		 User types.SignUpRequest

响应

HTTP代码 说明 类型
200 OK model.User
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • User

Reset Password For User

POST /api/v1/users/:id/reset_password

说明

reset password by json config

参数

类型 名称 说明 类型
Body User
必填		 User types.ResetPasswordRequest

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • User

Get User Roles

GET /api/v1/users/:id/roles

说明

get roles by json config

参数

类型 名称 说明 类型
Path id
必填		 id string

响应

HTTP代码 说明 类型
200 OK < string > array
400 无内容
500 无内容

生成

  • application/json

标签

  • User

Add Role For User

PUT /api/v1/users/:id/roles/:role

说明

add role to user by uri config

参数

类型 名称 说明 类型
Path id
必填		 id string
Path role
必填		 role string

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Users

Delete Role For User

DELETE /api/v1/users/:id/roles/:role

说明

delete role by uri config

参数

类型 名称 说明 类型
Path id
必填		 id string
Path role
必填		 role string

响应

HTTP代码 类型
200 无内容
400 无内容
500 无内容

消耗

  • application/json

生成

  • application/json

标签

  • Users

定义

model.Assertion

名称 类型
key
可选		 string
policy
可选		 < < string > array > array
policyMap
可选		 < string, integer > map
rm
可选		 rbac.RoleManager
tokens
可选		 < string > array
value
可选		 string

model.AssertionMap

类型 : < string, model.Assertion > map

model.CDN

名称 类型
cdnclusterID
可选		 integer
download_port
可选		 integer
host_name
可选		 string
idc
可选		 string
ip
可选		 string
location
可选		 string
port
可选		 integer
status
可选		 string

model.CDNCluster

名称 类型
bio
可选		 string
config
可选		 model.JSONMap
is_default
可选		 boolean
name
可选		 string
securityGroupID
可选		 integer

model.JSONMap

类型 : object

model.Oauth

名称 类型
bio
可选		 string
client_id
可选		 string
client_secret
可选		 string
name
可选		 string
redirect_url
可选		 string

model.Scheduler

名称 类型
host_name
可选		 string
idc
可选		 string
ip
可选		 string
location
可选		 string
net_config
可选		 model.JSONMap
port
可选		 integer
schedulerClusterID
可选		 integer
status
可选		 string
vips
可选		 string

model.SchedulerCluster

名称 类型
bio
可选		 string
client_config
可选		 model.JSONMap
config
可选		 model.JSONMap
is_default
可选		 boolean
name
可选		 string
scopes
可选		 model.JSONMap
securityGroupID
可选		 integer

model.SecurityGroup

名称 类型
bio
可选		 string
domain
可选		 string
name
可选		 string
proxy_domain
可选		 string

model.User

名称 类型
avatar
可选		 string
bio
可选		 string
email
可选		 string
location
可选		 string
name
可选		 string
phone
可选		 string
private_token
可选		 string
state
可选		 string

rbac.Permission

名称 类型
action
必填		 string
object
必填		 string

rbac.RoleManager

类型 : object

types.AddPermissionForRoleRequest

名称 类型
action
必填		 string
object
必填		 string

types.CreateCDNClusterRequest

名称 类型
bio
可选		 string
config
必填		 object
name
必填		 string
security_group_domain
可选		 string

types.CreateCDNRequest

名称 类型
cdn_cluster_id
必填		 integer
download_port
必填		 integer
host_name
必填		 string
idc
必填		 string
ip
必填		 string
location
可选		 string
port
必填		 integer

types.CreateOauthRequest

名称 类型
bio
可选		 string
client_id
必填		 string
client_secret
必填		 string
name
必填		 string
redirect_url
可选		 string

types.CreatePreheatRequest

名称 类型
filter
可选		 string
headers
可选		 < string, string > map
scheduler_cluster_id
可选		 integer
type
必填		 string
url
必填		 string

types.CreateRoleRequest

名称 类型
permissions
必填		 < rbac.Permission > array
role
必填		 string

types.CreateSchedulerClusterRequest

名称 类型
bio
可选		 string
cdn_cluster_id
可选		 integer
client_config
必填		 object
config
必填		 object
is_default
可选		 boolean
name
必填		 string
scopes
可选		 object
security_group_domain
可选		 string

types.CreateSchedulerRequest

名称 类型
host_name
必填		 string
idc
必填		 string
ip
必填		 string
location
可选		 string
net_config
可选		 object
port
必填		 integer
scheduler_cluster_id
必填		 integer
vips
可选		 string

types.CreateSecurityGroupRequest

名称 类型
bio
可选		 string
domain
必填		 string
name
必填		 string
proxy_domain
可选		 string

types.DeletePermissionForRoleRequest

名称 类型
action
必填		 string
object
必填		 string

types.Preheat

名称 类型
create_at
可选		 string
id
可选		 string
status
可选		 string

types.ResetPasswordRequest

名称 类型
new_password
必填		 string
old_password
必填		 string

types.SignUpRequest

名称 类型
avatar
可选		 string
bio
可选		 string
email
必填		 string
location
可选		 string
name
必填		 string
password
必填		 string
phone
可选		 string

types.UpdateCDNClusterRequest

名称 类型
bio
可选		 string
config
可选		 object
name
可选		 string
security_group_domain
可选		 string

types.UpdateCDNRequest

名称 类型
cdn_cluster_id
可选		 integer
download_port
可选		 integer
idc
可选		 string
ip
可选		 string
location
可选		 string
port
可选		 integer

types.UpdateOauthRequest

名称 类型
bio
可选		 string
client_id
可选		 string
client_secret
可选		 string
name
可选		 string
redirect_url
可选		 string

types.UpdateSchedulerClusterRequest

名称 类型
bio
可选		 string
cdn_cluster_id
可选		 integer
client_config
可选		 object
config
可选		 object
is_default
可选		 boolean
name
可选		 string
scopes
可选		 object
security_group_domain
可选		 string

types.UpdateSchedulerRequest

名称 类型
idc
可选		 string
ip
可选		 string
location
可选		 string
net_config
可选		 object
port
可选		 integer
scheduler_cluster_id
可选		 integer
scheduler_id
可选		 integer
vips
可选		 string

types.UpdateSecurityGroupRequest

名称 类型
bio
可选		 string
domain
可选		 string
name
可选		 string
proxy_domain
可选		 string