OpenPitrix Project (0.0.1)

Authentication

BearerAuth

The Authorization header must be set to Bearer followed by a space and a token. For example, 'Bearer vHUabiBEIKi8n1RdvWOjGFulGSM6zunb'.

Security scheme type: API Key
Header parameter name: Authorization

AccessManager

Validates whether the user[user_id] have permission to visit resource[url_method:url]

Authorizations:
Request Body schema: application/json
user_id
string (required, id of user to check whether has permission)
url
string (required, request uri)
url_method
string (required, url method, http verb)
api_method
string (rpc method eg.[Token|CanDo|...])

Responses

200

A successful response.

post /v1/cando
./v1/cando

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "url": "string",
  • "url_method": "string",
  • "api_method": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "access_path": "string",
  • "owner_path": "string"
}

Get role info

Authorizations:
query Parameters
role_id
string

required, use role id to get role info.

Responses

200

A successful response.

get /v1/role
./v1/role

Response samples

application/json
Copy
Expand all Collapse all
{
  • "role":
    {
    }
}

Get roles

Authorizations:
query Parameters
search_word
string

query key, support these fields(role_id, portal, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

offset
integer <int64>

data offset, default 0.

limit
integer <int64>

data limit per page, default value 20, max value 200.

role_id
Array of strings

role ids.

role_name
Array of strings

name.

portal
Array of strings

portal eg.[global_admin|user|isv].

status
Array of strings

status eg.[active|deleted].

action_bundle_id
Array of strings

action bundle ids.

Responses

200

A successful response.

get /v1/roles
./v1/roles

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "role_set":
    [
    ]
}

Batch delete roles

Authorizations:
Request Body schema: application/json
role_id
Array of strings (required, ids of role to delete)

Responses

200

A successful response.

delete /v1/roles
./v1/roles

Request samples

application/json
Copy
Expand all Collapse all
{
  • "role_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "role_id":
    [
    ]
}

Create role, different role has different permissions

Authorizations:
Request Body schema: application/json
role_name
string (required, role name)
description
string (role description)
portal
string (required, portal of role eg.[global_admin|user|isv])

Responses

200

A successful response.

post /v1/roles
./v1/roles

Request samples

application/json
Copy
Expand all Collapse all
{
  • "role_name": "string",
  • "description": "string",
  • "portal": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "role_id": "string"
}

Batch modify role info

Authorizations:
Request Body schema: application/json
role_id
string (required, id of role to modify)
role_name
string (role name)
description
string (role description)

Responses

200

A successful response.

patch /v1/roles
./v1/roles

Request samples

application/json
Copy
Expand all Collapse all
{
  • "role_id": "string",
  • "role_name": "string",
  • "description": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "role_id": "string"
}

Get role module, different role has different permission to access different module

Authorizations:
query Parameters
role_id
string

required, use role id to get role's module.

Responses

200

A successful response.

get /v1/roles:module
./v1/roles:module

Response samples

application/json
Copy
Expand all Collapse all
{
  • "role_id": "string",
  • "module":
    {
    }
}

Modify role module that can be visited

Authorizations:
Request Body schema: application/json
role_id
string (required, use role id to modify role module)
module
object (openpitrixModule)

Responses

200

A successful response.

post /v1/roles:module
./v1/roles:module

Request samples

application/json
Copy
Expand all Collapse all
{
  • "role_id": "string",
  • "module":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "role_id": "string"
}

Unbind user and role

Authorizations:
Request Body schema: application/json
user_id
Array of strings (ids of user to unbind)
role_id
Array of strings (ids of role for user to unbind with)

Responses

200

A successful response.

delete /v1/user:role
./v1/user:role

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id":
    [
    ],
  • "role_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id":
    [
    ],
  • "role_id":
    [
    ]
}

Bind role and user, a user belong to a role

Authorizations:
Request Body schema: application/json
user_id
Array of strings (required, ids of user to bind)
role_id
Array of strings (required, ids of role for user to bind with)

Responses

200

A successful response.

post /v1/user:role
./v1/user:role

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id":
    [
    ],
  • "role_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id":
    [
    ],
  • "role_id":
    [
    ]
}

AccountManager

Get groups, can filter with these fields(group_id, parent_group_id, group_path, status), default return all groups

Authorizations:
query Parameters
search_word
string

query key, support these fields(group_id, parent_group_id, group_path, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

root_group_id
Array of strings

use root group ids to get all groups.

parent_group_id
Array of strings

parent group ids.

group_id
Array of strings

group ids.

group_path
Array of strings

group path, a concat string gid-xxx.gid-xxx.gid...

group_name
Array of strings

group name.

status
Array of strings

status eg.[active|deleted].

Responses

200

A successful response.

get /v1/groups
./v1/groups

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "group_set":
    [
    ]
}

Delete groups

Authorizations:
Request Body schema: application/json
group_id
Array of strings (required, ids of group to delete)

Responses

200

A successful response.

delete /v1/groups
./v1/groups

Request samples

application/json
Copy
Expand all Collapse all
{
  • "group_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "group_id":
    [
    ]
}

Create group, a group contain one more user

Authorizations:
Request Body schema: application/json
parent_group_id
string (required, parent group id)
name
string (required, group name)
description
string (group description)

Responses

200

A successful response.

post /v1/groups
./v1/groups

Request samples

application/json
Copy
Expand all Collapse all
{
  • "parent_group_id": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "group_id": "string"
}

Modify group info

Authorizations:
Request Body schema: application/json
group_id
string (required, id of group to modify)
name
string (group name)
description
string (group description)
parent_group_id
string (parent group id)

Responses

200

A successful response.

patch /v1/groups
./v1/groups

Request samples

application/json
Copy
Expand all Collapse all
{
  • "group_id": "string",
  • "name": "string",
  • "description": "string",
  • "parent_group_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "group_id": "string"
}

Join groups, user can join in groups

Authorizations:
Request Body schema: application/json
group_id
Array of strings (required, ids of group for user to join in)
user_id
Array of strings (required, ids of user to join)

Responses

200

A successful response.

post /v1/groups:join
./v1/groups:join

Request samples

application/json
Copy
Expand all Collapse all
{
  • "group_id":
    [
    ],
  • "user_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "group_id":
    [
    ],
  • "user_id":
    [
    ]
}

Leave groups, user can leave from groups

Authorizations:
Request Body schema: application/json
group_id
Array of strings (required, ids of group for user to leave from)
user_id
Array of strings (required, ids of user to leave)

Responses

200

A successful response.

post /v1/groups:leave
./v1/groups:leave

Request samples

application/json
Copy
Expand all Collapse all
{
  • "group_id":
    [
    ],
  • "user_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "group_id":
    [
    ],
  • "user_id":
    [
    ]
}

Get groups, include all user in this group, can filter with these fields(group_id, parent_group_id, group_path, status), default return all groups

Authorizations:
query Parameters
search_word
string

query key, support these fields(group_id, parent_group_id, group_path, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

root_group_id
Array of strings

use root group ids to get all groups.

parent_group_id
Array of strings

parent group ids.

group_id
Array of strings

group ids.

group_path
Array of strings

group path, a concat string gid-xxx.gid-xxx.gid...

group_name
Array of strings

group name.

status
Array of strings

status eg.[active|deleted].

Responses

200

A successful response.

get /v1/groups_detail
./v1/groups_detail

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "group_detail_set":
    [
    ]
}

Isv of platform create user

Authorizations:
Request Body schema: application/json
email
string (required, user email)
phone_number
string (user phone number)
password
string (required, user password)
role_id
string (required, user role_id)
description
string (user description)

Responses

200

A successful response.

post /v1/isv_users
./v1/isv_users

Request samples

application/json
Copy
Expand all Collapse all
{
  • "email": "string",
  • "phone_number": "string",
  • "password": "string",
  • "role_id": "string",
  • "description": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Get users, filter with fields(user_id, email, phone_number, status), default return all users

Authorizations:
query Parameters
search_word
string

query key, support these fields(user_id, email, phone_number, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit, default 20, max 200.

offset
integer <int64>

data offset, default 0.

root_group_id
Array of strings

use root group ids to get all group ids.

group_id
Array of strings

group ids.

user_id
Array of strings

user ids.

status
Array of strings

status eg.[active|deleted].

role_id
Array of strings

role ids.

username
Array of strings

username.

email
Array of strings
phone_number
Array of strings

phone number, string of 11 digital.

Responses

200

A successful response.

get /v1/users
./v1/users

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "user_set":
    [
    ]
}

Delete user by user_id

Authorizations:
Request Body schema: application/json
user_id
Array of strings (required, ids of user to delete)

Responses

200

A successful response.

delete /v1/users
./v1/users

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id":
    [
    ]
}

Create user, if user have admin permission

Authorizations:
Request Body schema: application/json
email
string (required, user email)
phone_number
string (user phone number)
password
string (required, user password)
role_id
string (required, user role_id)
description
string (user description)

Responses

200

A successful response.

post /v1/users
./v1/users

Request samples

application/json
Copy
Expand all Collapse all
{
  • "email": "string",
  • "phone_number": "string",
  • "password": "string",
  • "role_id": "string",
  • "description": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Modify user info

Authorizations:
Request Body schema: application/json
user_id
string (required, id of user to be modify)
email
string (user email, eg.op@yunify.com)
username
string (user name)
description
string (user description)
password
string (user password)
phone_number
string (user phone number, string of 11 digital)

Responses

200

A successful response.

patch /v1/users
./v1/users

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "email": "string",
  • "username": "string",
  • "description": "string",
  • "password": "string",
  • "phone_number": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Change user password

Authorizations:
Request Body schema: application/json
new_password
string (required, new password for reset)
reset_id
string (required, reset id)

Responses

200

A successful response.

post /v1/users/password:change
./v1/users/password:change

Request samples

application/json
Copy
Expand all Collapse all
{
  • "new_password": "string",
  • "reset_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Get a request of reset user's password

Authorizations:
query Parameters
reset_id
string

required, reset id.

Responses

200

A successful response.

get /v1/users/password:reset
./v1/users/password:reset

Response samples

application/json
Copy
Expand all Collapse all
{
  • "reset_id": "string",
  • "user_id": "string"
}

Create a request to reset user's passwo

Authorizations:
Request Body schema: application/json
user_id
string (required, id of user to create reset password action)
password
string (required, user password)

Responses

200

A successful response.

post /v1/users/password:reset
./v1/users/password:reset

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "password": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "reset_id": "string"
}

Validate user and password

Authorizations:
Request Body schema: application/json
email
string (required, user email)
password
string (required, user password)

Responses

200

A successful response.

post /v1/users/password:validate
./v1/users/password:validate

Request samples

application/json
Copy
Expand all Collapse all
{
  • "email": "string",
  • "password": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "validated": true
}

Get users, include user info of role and group, filter with fields(user_id, email, phone_number, status), default return all users

Authorizations:
query Parameters
search_word
string

query key, support these fields(user_id, email, phone_number, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit, default 20, max 200.

offset
integer <int64>

data offset, default 0.

root_group_id
Array of strings

use root group ids to get all group ids.

group_id
Array of strings

group ids.

user_id
Array of strings

user ids.

status
Array of strings

status eg.[active|deleted].

role_id
Array of strings

role ids.

username
Array of strings

username.

email
Array of strings
phone_number
Array of strings

phone number, string of 11 digital.

Responses

200

A successful response.

get /v1/users_detail
./v1/users_detail

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "user_detail_set":
    [
    ]
}

TokenManager

Create client

Authorizations:
Request Body schema: application/json
user_id
string (required, user id for create client)

Responses

200

A successful response.

post /v1/oauth2/client
./v1/oauth2/client

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "client_id": "string",
  • "client_secret": "string"
}

Get users, include user info of role and group, filter with fields(user_id, email, phone_number, status), default return all users

Request Body schema: application/json
grant_type
string (required, type of client request verification.eg.[client_credentials or password or refresh_token])
client_id
string (required, client id)
client_secret
string (required, used for validate client credentials)
scope
string (scope)
username
string (required or not depend on grant_type, user's name)
password
string (required or not depend on grant_type, user's password)
refresh_token
string (required or not depend on grant_type, refresh token to check whether token expired)

Responses

200

A successful response.

post /v1/oauth2/token
./v1/oauth2/token

Request samples

application/json
Copy
Expand all Collapse all
{
  • "grant_type": "string",
  • "client_id": "string",
  • "client_secret": "string",
  • "scope": "string",
  • "username": "string",
  • "password": "string",
  • "refresh_token": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "token_type": "string",
  • "expires_in": 0,
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string"
}

AppManager

Get active versions of app, can filter with these fields(version_id, app_id, name, owner, description, package_name, status, type), default return all active app versions

Authorizations:
query Parameters
search_word
string

query key, support these fields(version_id, app_id, name, owner, description, package_name, status, type).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

version_id
Array of strings

app version ids.

app_id
Array of strings

app ids.

name
Array of strings

app version name.

owner
Array of strings

owner.

description
Array of strings

description.

package_name
Array of strings

app version package name.

status
Array of strings

app version status eg.[draft|submitted|passed|rejected|active|in-review|deleted|suspended].

type
Array of strings

app version type.

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/active_app_versions
./v1/active_app_versions

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "app_version_set":
    [
    ]
}

Get active apps, can filter with these fields(app_id, name, repo_id, description, status, home, icon, screenshots, maintainers, sources, readme, owner, chart_name), default return all apps

Authorizations:
query Parameters
search_word
string

query key, support these fields(app_id, name, repo_id, description, status, home, icon, screenshots, maintainers, sources, readme, owner, chart_name).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default is 20, max value is 200.

offset
integer <int64>

data offset, default is 0.

app_id
Array of strings

app ids.

name
Array of strings

app name.

repo_id
Array of strings

app repository ids.

status
Array of strings

app status eg.[modify|submit|review|cancel|release|delete|pass|reject|suspend|recover].

owner
Array of strings

app owner.

chart_name
Array of strings

app chart name.

category_id
Array of strings

app category ids.

display_columns
Array of strings

select column to display.

Responses

200

A successful response.

get /v1/active_apps
./v1/active_apps

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "app_set":
    [
    ]
}

Upload app attachment

Authorizations:
Request Body schema: application/json
app_id
string (required, id of app to upload attachment)
type
string (openpitrixUploadAppAttachmentRequestType)
Default: "icon"
Enum:"icon" "screenshot"
attachment_content
string <byte> (required, content of attachment)
sequence
integer <int64> (only for screenshot, range: [0, 5])

Responses

200

A successful response.

patch /v1/app/attachment
./v1/app/attachment

Request samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string",
  • "type": "icon",
  • "attachment_content": "string",
  • "sequence": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string"
}

Cancel version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to cancel)

Responses

200

A successful response.

post /v1/app_version/action/cancel
./v1/app_version/action/cancel

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Delete version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to delete)

Responses

200

A successful response.

post /v1/app_version/action/delete
./v1/app_version/action/delete

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of business pass version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to pass)

Responses

200

A successful response.

post /v1/app_version/action/pass/business
./v1/app_version/action/pass/business

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of isv pass version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to pass)

Responses

200

A successful response.

post /v1/app_version/action/pass/isv
./v1/app_version/action/pass/isv

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of technical pass version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to pass)

Responses

200

A successful response.

post /v1/app_version/action/pass/technical
./v1/app_version/action/pass/technical

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Recover version of app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to recover)

Responses

200

A successful response.

post /v1/app_version/action/recover
./v1/app_version/action/recover

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of business reject version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to reject)
message
string (reject message)

Responses

200

A successful response.

post /v1/app_version/action/reject/business
./v1/app_version/action/reject/business

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string",
  • "message": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of isv reject version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to reject)
message
string (reject message)

Responses

200

A successful response.

post /v1/app_version/action/reject/isv
./v1/app_version/action/reject/isv

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string",
  • "message": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of technical reject version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to reject)
message
string (reject message)

Responses

200

A successful response.

post /v1/app_version/action/reject/technical
./v1/app_version/action/reject/technical

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string",
  • "message": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Release version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to release)

Responses

200

A successful response.

post /v1/app_version/action/release
./v1/app_version/action/release

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of business review version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to review)

Responses

200

A successful response.

post /v1/app_version/action/review/business
./v1/app_version/action/review/business

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of isv review version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to review)

Responses

200

A successful response.

post /v1/app_version/action/review/isv
./v1/app_version/action/review/isv

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Operator of technical review version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to review)

Responses

200

A successful response.

post /v1/app_version/action/review/technical
./v1/app_version/action/review/technical

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Submit version of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to submit)

Responses

200

A successful response.

post /v1/app_version/action/submit
./v1/app_version/action/submit

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Suspend app version

Authorizations:
Request Body schema: application/json
version_id
string (required, id of version to suspend)

Responses

200

A successful response.

post /v1/app_version/action/suspend
./v1/app_version/action/suspend

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Get packages of version-specific app

Authorizations:
query Parameters
version_id
string

required, use version id to get package.

Responses

200

A successful response.

get /v1/app_version/package
./v1/app_version/package

Response samples

application/json
Copy
Expand all Collapse all
{
  • "package": "string",
  • "app_id": "string",
  • "version_id": "string"
}

Get app package files

Authorizations:
query Parameters
version_id
string

use version id to get file of package.

files
Array of strings

files.

Responses

200

A successful response.

get /v1/app_version/package/files
./v1/app_version/package/files

Response samples

application/json
Copy
Expand all Collapse all
{
  • "files":
    {
    },
  • "version_id": "string"
}

Get audits information of version-specific app, can filter with these fields(version_id, app_id, status, operator, role), default return all app version audits

Authorizations:
query Parameters
search_word
string

query key, support these fields(version_id, app_id, status, operator, role).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default is 20, max value is 200.

offset
integer <int64>

data offset, default is 0.

app_id
Array of strings

app ids.

version_id
Array of strings

app version ids.

status
Array of strings

app version audit status eg.[draft|submitted|passed|rejected|active|in-review|deleted|suspended].

operator
Array of strings

auditer of app version.

operator_type
Array of strings

operator type eg.[global_admin|developer|business|technical|isv].

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/app_version_audits
./v1/app_version_audits

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "app_version_audit_set":
    [
    ]
}

Get reviews of version-specific app, can filter with these fields(review_id, version_id, app_id, status, reviewer)

Authorizations:
query Parameters
search_word
string

query key, support these fields(review_id, version_id, app_id, status, reviewer).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default is 20, max value is 200.

offset
integer <int64>

data offset, default is 0.

app_id
Array of strings

app ids.

version_id
Array of strings

app version ids.

review_id
Array of strings

app version review ids.

status
Array of strings

app version status eg.[isv-in-review|isv-passed|isv-rejected|isv-draft|business-in-review|business-passed|business-rejected|develop-draft|develop-in-review|develop-passed|develop-rejected|develop-draft].

display_columns
Array of strings

select columns to display.

reviewer
Array of strings

reviewer of app version eg.[global_admin|developer|business|technical|isv].

Responses

200

A successful response.

get /v1/app_version_reviews
./v1/app_version_reviews

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "app_version_review_set":
    [
    ]
}

Get versions of app, can filter with these fields(version_id, app_id, name, owner, description, package_name, status, type), default return all app versions

Authorizations:
query Parameters
search_word
string

query key, support these fields(version_id, app_id, name, owner, description, package_name, status, type).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

version_id
Array of strings

app version ids.

app_id
Array of strings

app ids.

name
Array of strings

app version name.

owner
Array of strings

owner.

description
Array of strings

description.

package_name
Array of strings

app version package name.

status
Array of strings

app version status eg.[draft|submitted|passed|rejected|active|in-review|deleted|suspended].

type
Array of strings

app version type.

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/app_versions
./v1/app_versions

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "app_version_set":
    [
    ]
}

Create app of specific version

Authorizations:
Request Body schema: application/json
app_id
string (required, id of app to create new version)
name
string (required, version name eg.[0.1.0|0.1.3|...])
description
string (description of app of specific version)
type
string (optional: vmbased/helm)
package
string <byte> (package of app of specific version)

Responses

200

A successful response.

post /v1/app_versions
./v1/app_versions

Request samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "package": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Modify version info of the app

Authorizations:
Request Body schema: application/json
version_id
string (required, version id of app to modify)
name
string (app name)
description
string (app description)
package
string <byte> (package of app to replace other)
package_files
object (filename map to file_content)

Responses

200

A successful response.

patch /v1/app_versions
./v1/app_versions

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string",
  • "name": "string",
  • "description": "string",
  • "package": "string",
  • "package_files":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version_id": "string"
}

Get apps, can filter with these fields(app_id, name, repo_id, description, status, home, icon, screenshots, maintainers, sources, readme, owner, chart_name), default return all apps

Authorizations:
query Parameters
search_word
string

query key, support these fields(app_id, name, repo_id, description, status, home, icon, screenshots, maintainers, sources, readme, owner, chart_name).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default is 20, max value is 200.

offset
integer <int64>

data offset, default is 0.

app_id
Array of strings

app ids.

name
Array of strings

app name.

repo_id
Array of strings

app repository ids.

status
Array of strings

app status eg.[modify|submit|review|cancel|release|delete|pass|reject|suspend|recover].

owner
Array of strings

app owner.

chart_name
Array of strings

app chart name.

category_id
Array of strings

app category ids.

display_columns
Array of strings

select column to display.

Responses

200

A successful response.

get /v1/apps
./v1/apps

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "app_set":
    [
    ]
}

Batch delete apps

Authorizations:
Request Body schema: application/json
app_id
Array of strings (required, ids of app to delete)

Responses

200

A successful response.

delete /v1/apps
./v1/apps

Request samples

application/json
Copy
Expand all Collapse all
{
  • "app_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "app_id":
    [
    ]
}

Create app, user of isv can create app on the platform

Authorizations:
Request Body schema: application/json
name
string (required, app name)
version_type
string (optional, vmbased/helm)
version_package
string <byte> (required, version with specific app package)
version_name
string (required, version name of the app)
icon
string <byte> (app icon)

Responses

200

A successful response.

post /v1/apps
./v1/apps

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "version_type": "string",
  • "version_package": "string",
  • "version_name": "string",
  • "icon": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string",
  • "version_id": "string"
}

Modify app info

Authorizations:
Request Body schema: application/json
app_id
string (required, id of app to modify)
name
string (name of the app)
description
string (description of the app)
home
string (home page of the app)
maintainers
string (maintainers who maintainer the app)
sources
string (sources of app)
readme
string (instructions of the app)
abstraction
string (abstraction of app)
tos
string (tos of app)
category_id
string (category id of the app)
keywords
string (key words of the app)

Responses

200

A successful response.

patch /v1/apps
./v1/apps

Request samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string",
  • "name": "string",
  • "description": "string",
  • "home": "string",
  • "maintainers": "string",
  • "sources": "string",
  • "readme": "string",
  • "abstraction": "string",
  • "tos": "string",
  • "category_id": "string",
  • "keywords": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string"
}

Get statistics info of apps

Authorizations:

Responses

200

A successful response.

get /v1/apps/statistics
./v1/apps/statistics

Response samples

application/json
Copy
Expand all Collapse all
{
  • "last_two_week_created":
    {
    },
  • "top_ten_repos":
    {
    },
  • "app_count": 0,
  • "repo_count": 0
}

Validate format of package(pack by op tool)

Authorizations:
Request Body schema: application/json
version_type
string (optional, vmbased/helm)
version_package
string <byte> (required, version package eg.[the wordpress-0.0.1.tgz will be encoded to bytes])

Responses

200

A successful response.

post /v1/apps/validate_package
./v1/apps/validate_package

Request samples

application/json
Copy
Expand all Collapse all
{
  • "version_type": "string",
  • "version_package": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "error_details":
    {
    },
  • "error": "string",
  • "name": "string",
  • "version_name": "string"
}

AttachmentService

Get attachment, use attachment id to get attachment

Authorizations:
query Parameters
attachment_id
string

required, use attachment id to get attachment.

filename
string

filename, attachment contain one more file.

Responses

200

A successful response.

get /v1/attachments
./v1/attachments

Response samples

application/json
Copy
Expand all Collapse all
{
  • "content": "string",
  • "etag": "string"
}

CategoryManager

Get categories, support filter with these fields(category_id, status, locale, owner, name), default return all categories

Authorizations:
query Parameters
search_word
string

query key, can fields with these fields(category_id, status, locale, owner, name), default return all categories.

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

display_columns
Array of strings

select column to display.

category_id
Array of strings

category ids.

name
Array of strings

category name.

owner
Array of strings

owner.

Responses

200

A successful response.

get /v1/categories
./v1/categories

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "category_set":
    [
    ]
}

Batch delete categories

Authorizations:
Request Body schema: application/json
category_id
Array of strings (required, ids of category to delete)

Responses

200

A successful response.

delete /v1/categories
./v1/categories

Request samples

application/json
Copy
Expand all Collapse all
{
  • "category_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "category_id":
    [
    ]
}

Create category

Authorizations:
Request Body schema: application/json
name
string (required, category name)
locale
string (the i18n of this category, json format, sample: {"zh_cn": "数据库", "en": "database"})
description
string (category description)
icon
string <byte> (category icon)

Responses

200

A successful response.

post /v1/categories
./v1/categories

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "locale": "string",
  • "description": "string",
  • "icon": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "category_id": "string"
}

Modify category

Authorizations:
Request Body schema: application/json
category_id
string (required, id of category to modify)
name
string (category name)
locale
string (the i18n of this category, json format, sample: {"zh_cn": "数据库", "en": "database"})
description
string (category description)
icon
string <byte> (category icon)

Responses

200

A successful response.

patch /v1/categories
./v1/categories

Request samples

application/json
Copy
Expand all Collapse all
{
  • "category_id": "string",
  • "name": "string",
  • "locale": "string",
  • "description": "string",
  • "icon": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "category_id": "string"
}

ClusterManager

Get clusters, can filter with these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type), default return all clusters

Authorizations:
query Parameters
cluster_id
Array of strings

cluster ids.

app_id
Array of strings

app ids.

version_id
Array of strings

version ids.

status
Array of strings

cluster status eg.[active|used|enabled|disabled|deleted|stopped|ceased].

runtime_id
Array of strings

runtime ids.

frontgate_id
Array of strings

frontgate ids.

external_cluster_id
string

external cluster id.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

search_word
string

query key, support these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

owner
Array of strings

owner.

cluster_type
string

cluster type, frontgate or normal cluster.

with_detail
boolean <boolean>

get cluster detail info or not.

created_date
integer <int64>

cluster created duration eg.[1 day].

display_columns
Array of strings

select column to display.

Responses

200

A successful response.

get /v1/clusters
./v1/clusters

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "cluster_set":
    [
    ]
}

Batch add nodes to cluster

Authorizations:
Request Body schema: application/json
cluster_id
string (required, id of cluster to add node)
role
string (required, role eg:[mysql|wordpress|...])
node_count
integer <int64> (number of node added to cluster)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/add_nodes
./v1/clusters/add_nodes

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "role": "string",
  • "node_count": 0,
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Get app clusters, can filter with these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type), default return all app clusters

Authorizations:
query Parameters
app_id
Array of strings

app ids.

status
Array of strings

status eg.[active|used|enabled|disabled|deleted|stopped|ceased].

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

search_word
string

query key, support these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

owner
Array of strings

owner.

with_detail
boolean <boolean>

get cluster with detail.

created_date
integer <int64>

cluster created duration eg.[1 day].

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/clusters/apps
./v1/clusters/apps

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "cluster_set":
    [
    ]
}

Batch cease clusters

Authorizations:
Request Body schema: application/json
cluster_id
Array of strings (required, ids of cluster to cease)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/cease
./v1/clusters/cease

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "job_id":
    [
    ]
}

Create cluster

Authorizations:
Request Body schema: application/json
app_id
string (required, id of app to run in cluster)
version_id
string (required, id of app version)
runtime_id
string (required, id of runtime)
conf
string (required, conf a json string, include cpu, memory info of cluster)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/create
./v1/clusters/create

Request samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string",
  • "version_id": "string",
  • "runtime_id": "string",
  • "conf": "string",
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Batch delete clusters

Authorizations:
Request Body schema: application/json
cluster_id
Array of strings (required, ids of clusters to delete)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/delete
./v1/clusters/delete

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "job_id":
    [
    ]
}

Batch delete nodes from cluster

Authorizations:
Request Body schema: application/json
cluster_id
string (required, id of cluster to delete node)
node_id
Array of strings (required, node ids)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/delete_nodes
./v1/clusters/delete_nodes

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "node_id":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Batch attach key pairs to node

Authorizations:
Request Body schema: application/json
key_pair_id
Array of strings (ids of key pairs to attach)
node_id
Array of strings (ids of node to attached)

Responses

200

A successful response.

post /v1/clusters/key_pair/attach
./v1/clusters/key_pair/attach

Request samples

application/json
Copy
Expand all Collapse all
{
  • "key_pair_id":
    [
    ],
  • "node_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "job_id":
    [
    ]
}

Batch detach key pairs from node

Authorizations:
Request Body schema: application/json
key_pair_id
Array of strings (ids of key pairs to detach)
node_id
Array of strings (ids of nodes to detached)

Responses

200

A successful response.

post /v1/clusters/key_pair/detach
./v1/clusters/key_pair/detach

Request samples

application/json
Copy
Expand all Collapse all
{
  • "key_pair_id":
    [
    ],
  • "node_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "job_id":
    [
    ]
}

Get key pairs, support filter with these fields(key_pair_id, name, owner), default return all key pairs

Authorizations:
query Parameters
key_pair_id
string

key pair id.

name
string

key pair name.

description
string

key pair description.

pub_key
string

public key.

owner
Array of strings

owner.

search_word
string

query key, can filter with these fields(key_pair_id, name, owner).

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/clusters/key_pairs
./v1/clusters/key_pairs

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "key_pair_set":
    [
    ]
}

Batch delete key pairs

Authorizations:
Request Body schema: application/json
key_pair_id
Array of strings (required, ids of key pairs to delete)

Responses

200

A successful response.

delete /v1/clusters/key_pairs
./v1/clusters/key_pairs

Request samples

application/json
Copy
Expand all Collapse all
{
  • "key_pair_id":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "key_pair_id":
    [
    ]
}

Create key pair

Authorizations:
Request Body schema: application/json
name
string (keypair name)
description
string (keypair description)
pub_key
string (public key)

Responses

200

A successful response.

post /v1/clusters/key_pairs
./v1/clusters/key_pairs

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "pub_key": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "key_pair_id": "string"
}

Modify cluster attributes

Authorizations:
Request Body schema: application/json
cluster_id
string (required, id of cluster to modify)
name
string (cluster name)
description
string (cluster description)

Responses

200

A successful response.

post /v1/clusters/modify
./v1/clusters/modify

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string"
}

Modify node attributes in the cluster

Authorizations:
Request Body schema: application/json
node_id
string (required, id of cluster node to modify)
name
string (node name)

Responses

200

A successful response.

post /v1/clusters/modify_nodes
./v1/clusters/modify_nodes

Request samples

application/json
Copy
Expand all Collapse all
{
  • "node_id": "string",
  • "name": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "node_id": "string"
}

Get nodes in cluster, can filter with these fields(cluster_id, node_id, status, owner)

Authorizations:
query Parameters
cluster_id
string

cluster id.

node_id
Array of strings

node ids.

status
Array of strings

status eg.[active|used|enabled|disabled|deleted|stopped|ceased].

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

search_word
string

query key, support these fields(cluster_id, node_id, status, owner).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

owner
Array of strings

owner.

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/clusters/nodes
./v1/clusters/nodes

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "cluster_node_set":
    [
    ]
}

Batch recover clusters

Authorizations:
Request Body schema: application/json
cluster_id
Array of strings (required, ids of clusters to recover)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/recover
./v1/clusters/recover

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "job_id":
    [
    ]
}

Resize cluster

Authorizations:
Request Body schema: application/json
cluster_id
string (required, id of cluster to resize)
role_resource
Array of objects (list of role resource)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/resize
./v1/clusters/resize

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "role_resource":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Rollback cluster

Authorizations:
Request Body schema: application/json
cluster_id
string (required, id of cluster to rollback)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/rollback
./v1/clusters/rollback

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Batch start clusters

Authorizations:
Request Body schema: application/json
cluster_id
Array of strings (required, ids of cluster to start)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/start
./v1/clusters/start

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "job_id":
    [
    ]
}

Get statistics of cluster

Authorizations:

Responses

200

A successful response.

get /v1/clusters/statistics
./v1/clusters/statistics

Response samples

application/json
Copy
Expand all Collapse all
{
  • "last_two_week_created":
    {
    },
  • "top_ten_runtimes":
    {
    },
  • "cluster_count": 0,
  • "runtime_count": 0,
  • "top_ten_apps":
    {
    }
}

Batch stop clusters

Authorizations:
Request Body schema: application/json
cluster_id
Array of strings (required, ids of cluster to stop)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/stop
./v1/clusters/stop

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id":
    [
    ],
  • "job_id":
    [
    ]
}

Get subnets

Authorizations:
query Parameters
runtime_id
string

required, id of runtime that contain subnet.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

subnet_type
integer <int64>

subnet type.

subnet_id
Array of strings

subnet ids.

zone
Array of strings

zone eg.[pek3a|pek3b|...].

advanced_param
Array of strings

advanced param.

Responses

200

A successful response.

get /v1/clusters/subnets
./v1/clusters/subnets

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "subnet_set":
    [
    ]
}

Update env of cluster

Authorizations:
Request Body schema: application/json
cluster_id
string (id of cluster to update env)
env
string (env)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

patch /v1/clusters/update_env
./v1/clusters/update_env

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "env": "string",
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Upgrade cluster

Authorizations:
Request Body schema: application/json
cluster_id
string (required, id of cluster to upgrade)
version_id
string (app version id)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/clusters/upgrade
./v1/clusters/upgrade

Request samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "version_id": "string",
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

Get debug clusters, can filter with these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type), default return all debug clusters

Authorizations:
query Parameters
cluster_id
Array of strings

cluster ids.

app_id
Array of strings

app ids.

version_id
Array of strings

version ids.

status
Array of strings

cluster status eg.[active|used|enabled|disabled|deleted|stopped|ceased].

runtime_id
Array of strings

runtime ids.

frontgate_id
Array of strings

frontgate ids.

external_cluster_id
string

external cluster id.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

search_word
string

query key, support these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

owner
Array of strings

owner.

cluster_type
string

cluster type, frontgate or normal cluster.

with_detail
boolean <boolean>

get cluster detail info or not.

created_date
integer <int64>

cluster created duration eg.[1 day].

display_columns
Array of strings

select column to display.

Responses

200

A successful response.

get /v1/debug_clusters
./v1/debug_clusters

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "cluster_set":
    [
    ]
}

Get debug app clusters, can filter with these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type), default return all debug app clusters

Authorizations:
query Parameters
app_id
Array of strings

app ids.

status
Array of strings

status eg.[active|used|enabled|disabled|deleted|stopped|ceased].

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

search_word
string

query key, support these fields(cluster_id, app_id, version_id, status, runtime_id, frontgate_id, owner, cluster_type).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

owner
Array of strings

owner.

with_detail
boolean <boolean>

get cluster with detail.

created_date
integer <int64>

cluster created duration eg.[1 day].

display_columns
Array of strings

select columns to display.

Responses

200

A successful response.

get /v1/debug_clusters/apps
./v1/debug_clusters/apps

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "cluster_set":
    [
    ]
}

Create debug cluster

Authorizations:
Request Body schema: application/json
app_id
string (required, id of app to run in cluster)
version_id
string (required, id of app version)
runtime_id
string (required, id of runtime)
conf
string (required, conf a json string, include cpu, memory info of cluster)
advanced_param
Array of strings (advanced param)

Responses

200

A successful response.

post /v1/debug_clusters/create
./v1/debug_clusters/create

Request samples

application/json
Copy
Expand all Collapse all
{
  • "app_id": "string",
  • "version_id": "string",
  • "runtime_id": "string",
  • "conf": "string",
  • "advanced_param":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "cluster_id": "string",
  • "job_id": "string"
}

IsvManager

Get vendor verifies info, can filer with these fields(user_id, status), default return all VendorVerifyInfos

Authorizations:
query Parameters
search_word
string

query key, support these fields(user_id, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

user_id
Array of strings

user ids.

status
Array of strings

status eg.[draft|submitted|passed|rejected|suspended|in-review|new].

display_columns
Array of strings

select column to display.

owner
Array of strings

owner.

Responses

200

A successful response.

get /v1/app_vendors
./v1/app_vendors

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "vendor_verify_info_set":
    [
    ]
}

Submit vendor verify info

Authorizations:
Request Body schema: application/json
user_id
string (required, id of user to submit)
company_name
string (required, company name)
company_website
string (company website)
company_profile
string (company profile)
authorizer_name
string (required, authorizer name)
authorizer_email
string (required, authorizer email eg. xxx@yunify.com)
authorizer_phone
string (authorizer phone, string of 11 digit)
bank_name
string (bank name)
bank_account_name
string (bank account name)
bank_account_number
string (bank account number)

Responses

200

A successful response.

post /v1/app_vendors
./v1/app_vendors

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "company_name": "string",
  • "company_website": "string",
  • "company_profile": "string",
  • "authorizer_name": "string",
  • "authorizer_email": "string",
  • "authorizer_phone": "string",
  • "bank_name": "string",
  • "bank_account_name": "string",
  • "bank_account_number": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Get vendor verify info

Authorizations:
query Parameters
user_id
string

required, use user id to get vendor verify info.

Responses

200

A successful response.

get /v1/app_vendors/app_vendor
./v1/app_vendors/app_vendor

Response samples

application/json
Copy
Expand all Collapse all
{
  • "vendor_verify_info":
    {
    }
}

Get statistics of vendor

Authorizations:
query Parameters
search_word
string

query key, support these fields(user_id, status).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

user_id
Array of strings

user ids.

status
Array of strings

status eg.[draft|submitted|passed|rejected|suspended|in-review|new].

display_columns
Array of strings

select column to display.

owner
Array of strings

owner.

Responses

200

A successful response.

get /v1/app_vendors/app_vendor_statistics
./v1/app_vendors/app_vendor_statistics

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "vendor_verify_statistics_set":
    [
    ]
}

Pass vendor verify

Authorizations:
Request Body schema: application/json
user_id
string (required, id of user to pass)

Responses

200

A successful response.

post /v1/app_vendors/pass
./v1/app_vendors/pass

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

Reject vendor verify

Authorizations:
Request Body schema: application/json
user_id
string (required, id of user to reject)
reject_message
string (reject message)

Responses

200

A successful response.

post /v1/app_vendors/reject
./v1/app_vendors/reject

Request samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string",
  • "reject_message": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "user_id": "string"
}

JobManager

Get job, filter with these fields(job_id, cluster_id, app_id, version_id, executor, provider, status, owner), default return all jobs

Authorizations:
query Parameters
search_word
string

query key, support these fields(job_id, cluster_id, app_id, version_id, executor, provider, status, owner).

sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

data limit per page, default value 20, max value 200.

offset
integer <int64>

data offset, default 0.

display_columns
Array of strings

select column to display.

job_id
Array of strings

job ids.

cluster_id
string

cluster id.

app_id
string

app id.

version_id
string

specific app version id to filter result.

executor
string

host name of server.

provider
string

runtime provider eg.[qingcloud|aliyun|aws|kubernetes].

runtime_id
string

runtime id.

status
Array of strings

status eg.[successful|failed|running|pending].

owner
Array of strings

owner.

Responses

200

A successful response.

get /v1/jobs
./v1/jobs

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "job_set":
    [
    ]
}

MarketManager

Get users with filter

Authorizations:
query Parameters
search_word
string
sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

default is 20, max value is 200.

offset
integer <int64>

default is 0.

market_id
Array of strings
user_id
Array of strings
owner
Array of strings

Responses

200

A successful response.

get /v1/market_users
./v1/market_users

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "market_user_set":
    [
    ]
}

Describe markets with filter

Authorizations:
query Parameters
search_word
string
sort_key
string

sort key, order by sort_key, default create_time.

reverse
boolean <boolean>

value = 0 sort ASC, value = 1 sort DESC.

limit
integer <int64>

default is 20, max value is 200.

offset
integer <int64>

default is 0.

market_id
Array of strings
name
Array of strings
visibility
Array of strings
status
Array of strings
owner
Array of strings
user_id
Array of strings

Responses

200

A successful response.

get /v1/markets
./v1/markets

Response samples

application/json
Copy
Expand all Collapse all
{
  • "total_count": 0,
  • "market_set":
    [
    ]
}

Delete markets

Authorizations:
Request Body schema: application/json
market_id
Array of strings

Responses

200

A successful response.