Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Files = map[string]string{
"api.swagger.json": `{
"swagger": "2.0",
"info": {
"title": "OpenPitrix Project",
"version": "0.0.1",
"contact": {
"name": "OpenPitrix Project",
"url": "https://openpitrix.io"
}
},
"schemes": [
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/app_version/package": {
"get": {
"summary": "get the package content of app version",
"operationId": "GetAppVersionPackage",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetAppVersionPackageResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/package/files": {
"get": {
"summary": "get the package files content of app version",
"operationId": "GetAppVersionPackageFiles",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetAppVersionPackageFilesResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "files",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_versions": {
"get": {
"summary": "describe app versions with filter",
"operationId": "DescribeAppVersions",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppVersionsResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "description",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "package_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
}
],
"tags": [
"AppManager"
]
},
"delete": {
"summary": "delete app versions",
"operationId": "DeleteAppVersions",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppVersionsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppVersionsRequest"
}
}
],
"tags": [
"AppManager"
]
},
"post": {
"summary": "create app version",
"operationId": "CreateAppVersion",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
},
"patch": {
"summary": "modify app version",
"operationId": "ModifyAppVersion",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/apps": {
"get": {
"summary": "describe apps with filter",
"operationId": "DescribeApps",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "chart_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
},
"delete": {
"summary": "delete apps",
"operationId": "DeleteApps",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppsRequest"
}
}
],
"tags": [
"AppManager"
]
},
"post": {
"summary": "create app",
"operationId": "CreateApp",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateAppResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateAppRequest"
}
}
],
"tags": [
"AppManager"
]
},
"patch": {
"summary": "modify app",
"operationId": "ModifyApp",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyAppResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyAppRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/apps/statistics": {
"get": {
"summary": "get app statistics",
"operationId": "GetAppStatistics",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetAppStatisticsResponse"
}
}
},
"tags": [
"AppManager"
]
}
},
"/v1/categories": {
"get": {
"summary": "describe categories with filter",
"operationId": "DescribeCategories",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeCategoriesResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
}
],
"tags": [
"CategoryManager"
]
},
"delete": {
"summary": "delete categories",
"operationId": "DeleteCategories",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteCategoriesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteCategoriesRequest"
}
}
],
"tags": [
"CategoryManager"
]
},
"post": {
"summary": "create category",
"operationId": "CreateCategory",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateCategoryResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateCategoryRequest"
}
}
],
"tags": [
"CategoryManager"
]
},
"patch": {
"summary": "modify category",
"operationId": "ModifyCategory",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyCategoryResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyCategoryRequest"
}
}
],
"tags": [
"CategoryManager"
]
}
},
"/v1/clusters": {
"get": {
"summary": "describe clusters",
"operationId": "DescribeClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeClustersResponse"
}
}
},
"parameters": [
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "frontgate_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "external_cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/add_nodes": {
"post": {
"summary": "add cluster nodes",
"operationId": "AddClusterNodes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixAddClusterNodesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixAddClusterNodesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/cease": {
"post": {
"summary": "cease clusters",
"operationId": "CeaseClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCeaseClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCeaseClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/create": {
"post": {
"summary": "create cluster",
"operationId": "CreateCluster",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/delete": {
"post": {
"summary": "delete clusters",
"operationId": "DeleteClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/delete_nodes": {
"post": {
"summary": "delete cluster nodes",
"operationId": "DeleteClusterNodes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteClusterNodesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteClusterNodesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/key_pair/attach": {
"post": {
"summary": "attach key pairs",
"operationId": "AttachKeyPairs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixAttachKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixAttachKeyPairsRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/key_pair/detach": {
"post": {
"summary": "detach key pairs",
"operationId": "DetachKeyPairs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDetachKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDetachKeyPairsRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/key_pairs": {
"get": {
"summary": "describe key pairs",
"operationId": "DescribeKeyPairs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "key_pair_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pub_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"ClusterManager"
]
},
"delete": {
"summary": "delete key pairs",
"operationId": "DeleteKeyPairs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteKeyPairsRequest"
}
}
],
"tags": [
"ClusterManager"
]
},
"post": {
"summary": "create key pair",
"operationId": "CreateKeyPair",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateKeyPairResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateKeyPairRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/modify": {
"post": {
"summary": "modify cluster attributes",
"operationId": "ModifyClusterAttributes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterAttributesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterAttributesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/modify_nodes": {
"post": {
"summary": "modify cluster node attributes",
"operationId": "ModifyClusterNodeAttributes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterNodeAttributesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterNodeAttributesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/nodes": {
"get": {
"summary": "describe cluster nodes",
"operationId": "DescribeClusterNodes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeClusterNodesResponse"
}
}
},
"parameters": [
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "node_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/recover": {
"post": {
"summary": "recover clusters",
"operationId": "RecoverClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixRecoverClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRecoverClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/resize": {
"post": {
"summary": "resize cluster",
"operationId": "ResizeCluster",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixResizeClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixResizeClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/rollback": {
"post": {
"summary": "rollback cluster",
"operationId": "RollbackCluster",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixRollbackClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRollbackClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/start": {
"post": {
"summary": "start clusters",
"operationId": "StartClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixStartClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixStartClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/statistics": {
"get": {
"summary": "get cluster statistics",
"operationId": "GetClusterStatistics",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetClusterStatisticsResponse"
}
}
},
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/stop": {
"post": {
"summary": "stop clusters",
"operationId": "StopClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixStopClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixStopClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/subnets": {
"get": {
"summary": "describe subnets",
"operationId": "DescribeSubnets",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeSubnetsResponse"
}
}
},
"parameters": [
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "subnet_type",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "subnet_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "zone",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "advanced_param",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/update_env": {
"patch": {
"summary": "update cluster env",
"operationId": "UpdateClusterEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixUpdateClusterEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUpdateClusterEnvRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/upgrade": {
"post": {
"summary": "upgrade cluster",
"operationId": "UpgradeCluster",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixUpgradeClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUpgradeClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/jobs": {
"get": {
"summary": "describe jobs with filter",
"operationId": "DescribeJobs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeJobsResponse"
}
}
},
"parameters": [
{
"name": "job_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "executor",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"JobManager"
]
}
},
"/v1/repos": {
"get": {
"summary": "describe repos with filter",
"operationId": "DescribeRepos",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeReposResponse"
}
}
},
"parameters": [
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "type",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "visibility",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "label",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "selector",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
}
],
"tags": [
"RepoManager"
]
},
"delete": {
"summary": "delete repos",
"operationId": "DeleteRepos",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteReposResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteReposRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"post": {
"summary": "create repo",
"operationId": "CreateRepo",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"patch": {
"summary": "modify repo",
"operationId": "ModifyRepo",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoRequest"
}
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repos/validate": {
"get": {
"summary": "validate repo",
"operationId": "ValidateRepo",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixValidateRepoResponse"
}
}
},
"parameters": [
{
"name": "type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "url",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "credential",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repo_events": {
"get": {
"summary": "describe repo events",
"operationId": "DescribeRepoEvents",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRepoEventsResponse"
}
}
},
"parameters": [
{
"name": "repo_event_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RepoIndexer"
]
}
},
"/v1/repos/index": {
"post": {
"summary": "start a index repo event",
"operationId": "IndexRepo",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixIndexRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixIndexRepoRequest"
}
}
],
"tags": [
"RepoIndexer"
]
}
},
"/v1/runtimes": {
"get": {
"summary": "describe runtime",
"operationId": "DescribeRuntimes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimesResponse"
}
}
},
"parameters": [
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "label",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RuntimeManager"
]
},
"delete": {
"summary": "delete runtimes",
"operationId": "DeleteRuntimes",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimesRequest"
}
}
],
"tags": [
"RuntimeManager"
]
},
"post": {
"summary": "create runtime",
"operationId": "CreateRuntime",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeRequest"
}
}
],
"tags": [
"RuntimeManager"
]
},
"patch": {
"summary": "modify runtime",
"operationId": "ModifyRuntime",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeRequest"
}
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes/statistics": {
"get": {
"summary": "get runtime statistics",
"operationId": "GetRuntimeStatistics",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetRuntimeStatisticsResponse"
}
}
},
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes/zones": {
"get": {
"summary": "describe runtime provider zones",
"operationId": "DescribeRuntimeProviderZones",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimeProviderZonesResponse"
}
}
},
"parameters": [
{
"name": "provider",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "runtime_url",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "runtime_credential",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/tasks": {
"get": {
"summary": "describe tasks with filter",
"operationId": "DescribeTasks",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeTasksResponse"
}
}
},
"parameters": [
{
"name": "task_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "job_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "executor",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "target",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"TaskManager"
]
}
},
"/v1/tasks/retry": {
"post": {
"summary": "retry tasks",
"operationId": "RetryTasks",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixRetryTasksResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRetryTasksRequest"
}
}
],
"tags": [
"TaskManager"
]
}
}
},
"definitions": {
"openpitrixApp": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"name": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"keywords": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"owner": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"category_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixResourceCategory"
}
},
"latest_app_version": {
"$ref": "#/definitions/openpitrixAppVersion"
}
}
},
"openpitrixAppVersion": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"package_name": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"sequence": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixCreateAppRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"description": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"category_id": {
"type": "string"
},
"keywords": {
"type": "string"
}
}
},
"openpitrixCreateAppResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
}
}
},
"openpitrixCreateAppVersionRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"description": {
"type": "string"
},
"sequence": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixCreateAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixDeleteAppVersionsRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteAppVersionsResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteAppsRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteAppsResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeAppVersionsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"app_version_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixAppVersion"
}
}
}
},
"openpitrixDescribeAppsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"app_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixApp"
}
}
}
},
"openpitrixGetAppStatisticsResponse": {
"type": "object",
"properties": {
"last_two_week_created": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"top_ten_repos": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"app_count": {
"type": "integer",
"format": "int64"
},
"repo_count": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixGetAppVersionPackageFilesResponse": {
"type": "object",
"properties": {
"files": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "byte"
}
},
"version_id": {
"type": "string"
}
}
},
"openpitrixGetAppVersionPackageResponse": {
"type": "object",
"properties": {
"package": {
"type": "string",
"format": "byte"
},
"version_id": {
"type": "string"
}
}
},
"openpitrixModifyAppRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"name": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"description": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"category_id": {
"type": "string"
},
"keywords": {
"type": "string"
}
}
},
"openpitrixModifyAppResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
}
}
},
"openpitrixModifyAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"owner": {
"type": "string"
},
"description": {
"type": "string"
},
"sequence": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixModifyAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixResourceCategory": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCategory": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"owner": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateCategoryRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateCategoryResponse": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
}
}
},
"openpitrixDeleteCategoriesRequest": {
"type": "object",
"properties": {
"category_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteCategoriesResponse": {
"type": "object",
"properties": {
"category_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeCategoriesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"category_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixCategory"
}
}
}
},
"openpitrixModifyCategoryRequest": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixModifyCategoryResponse": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
}
}
},
"openpitrixAddClusterNodesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"node_count": {
"type": "integer",
"format": "int64"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixAddClusterNodesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixAddNodeKeyPairsResponse": {
"type": "object"
},
"openpitrixAttachKeyPairsRequest": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixAttachKeyPairsResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCeaseClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCeaseClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCluster": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"subnet_id": {
"type": "string"
},
"vpc_id": {
"type": "string"
},
"frontgate_id": {
"type": "string"
},
"cluster_type": {
"type": "integer",
"format": "int64"
},
"endpoints": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"metadata_root_access": {
"type": "boolean",
"format": "boolean"
},
"owner": {
"type": "string"
},
"global_uuid": {
"type": "string"
},
"upgrade_status": {
"type": "string"
},
"upgrade_time": {
"type": "string",
"format": "date-time"
},
"runtime_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"cluster_node_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterNode"
}
},
"cluster_role_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterRole"
}
},
"cluster_link_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterLink"
}
},
"cluster_common_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterCommon"
}
},
"cluster_loadbalancer_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterLoadbalancer"
}
}
}
},
"openpitrixClusterCommon": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"server_id_upper_bound": {
"type": "integer",
"format": "int64"
},
"advanced_actions": {
"type": "string"
},
"init_service": {
"type": "string"
},
"start_service": {
"type": "string"
},
"stop_service": {
"type": "string"
},
"scale_out_service": {
"type": "string"
},
"scale_in_service": {
"type": "string"
},
"restart_service": {
"type": "string"
},
"destroy_service": {
"type": "string"
},
"upgrade_service": {
"type": "string"
},
"custom_service": {
"type": "string"
},
"backup_service": {
"type": "string"
},
"restore_service": {
"type": "string"
},
"delete_snapshot_service": {
"type": "string"
},
"health_check": {
"type": "string"
},
"monitor": {
"type": "string"
},
"passphraseless": {
"type": "string"
},
"vertical_scaling_policy": {
"type": "string"
},
"agent_installed": {
"type": "boolean",
"format": "boolean"
},
"custom_metadata_script": {
"type": "string"
},
"image_id": {
"type": "string"
},
"backup_policy": {
"type": "string"
},
"incremental_backup_supported": {
"type": "boolean",
"format": "boolean"
},
"hypervisor": {
"type": "string"
}
}
},
"openpitrixClusterLink": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"external_cluster_id": {
"type": "string"
},
"owner": {
"type": "string"
}
}
},
"openpitrixClusterLoadbalancer": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"loadbalancer_listener_id": {
"type": "string"
},
"loadbalancer_port": {
"type": "integer",
"format": "int64"
},
"loadbalancer_policy_id": {
"type": "string"
}
}
},
"openpitrixClusterNode": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"instance_id": {
"type": "string"
},
"volume_id": {
"type": "string"
},
"device": {
"type": "string"
},
"subnet_id": {
"type": "string"
},
"private_ip": {
"type": "string"
},
"eip": {
"type": "string"
},
"server_id": {
"type": "integer",
"format": "int64"
},
"role": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"group_id": {
"type": "integer",
"format": "int64"
},
"owner": {
"type": "string"
},
"global_server_id": {
"type": "integer",
"format": "int64"
},
"custom_metadata": {
"type": "string"
},
"pub_key": {
"type": "string"
},
"health_status": {
"type": "string"
},
"is_backup": {
"type": "boolean",
"format": "boolean"
},
"auto_backup": {
"type": "boolean",
"format": "boolean"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"cluster_role": {
"$ref": "#/definitions/openpitrixClusterRole"
},
"cluster_common": {
"$ref": "#/definitions/openpitrixClusterCommon"
},
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixClusterRole": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"cpu": {
"type": "integer",
"format": "int64"
},
"gpu": {
"type": "integer",
"format": "int64"
},
"memory": {
"type": "integer",
"format": "int64"
},
"instance_size": {
"type": "integer",
"format": "int64"
},
"storage_size": {
"type": "integer",
"format": "int64"
},
"mount_point": {
"type": "string"
},
"mount_options": {
"type": "string"
},
"file_system": {
"type": "string"
},
"env": {
"type": "string"
}
}
},
"openpitrixCreateClusterRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"runtime_id": {
"type": "string"
},
"conf": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCreateClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixCreateKeyPairRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"pub_key": {
"type": "string"
}
}
},
"openpitrixCreateKeyPairResponse": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "string"
}
}
},
"openpitrixDeleteClusterNodesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteClusterNodesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixDeleteClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteKeyPairsRequest": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteKeyPairsResponse": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteNodeKeyPairsResponse": {
"type": "object"
},
"openpitrixDescribeClusterNodesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"cluster_node_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterNode"
}
}
}
},
"openpitrixDescribeClustersResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"cluster_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixCluster"
}
}
}
},
"openpitrixDescribeKeyPairsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"key_pair_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixKeyPair"
}
}
}
},
"openpitrixDescribeSubnetsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"subnet_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixSubnet"
}
}
}
},
"openpitrixDetachKeyPairsRequest": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDetachKeyPairsResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixGetClusterStatisticsResponse": {
"type": "object",
"properties": {
"last_two_week_created": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"top_ten_runtimes": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"cluster_count": {
"type": "integer",
"format": "int64"
},
"runtime_count": {
"type": "integer",
"format": "int64"
},
"top_ten_apps": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
}
},
"openpitrixKeyPair": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"pub_key": {
"type": "string"
},
"owner": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixModifyClusterAttributesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixModifyClusterAttributesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterNodeAttributesRequest": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"openpitrixModifyClusterNodeAttributesResponse": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterNodeResponse": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
}
}
},
"openpitrixNodeKeyPair": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"key_pair_id": {
"type": "string"
}
}
},
"openpitrixRecoverClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixRecoverClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixResizeClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"cpu": {
"type": "integer",
"format": "int64"
},
"memory": {
"type": "integer",
"format": "int64"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixResizeClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixRollbackClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixRollbackClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixStartClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixStartClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixStopClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixStopClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixSubnet": {
"type": "object",
"properties": {
"subnet_id": {
"type": "string"
},
"name": {
"type": "string"
},
"zone": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"instance_id": {
"type": "array",
"items": {
"type": "string"
}
},
"vpc_id": {
"type": "string"
},
"subnet_type": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixUpdateClusterEnvRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"env": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUpdateClusterEnvResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixUpgradeClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUpgradeClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"protobufEmpty": {
"type": "object",
"description": "service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for ` + "`" + `Empty` + "`" + ` is empty JSON object ` + "`" + `{}` + "`" + `.",
"title": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:"
},
"openpitrixCreateJobResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
}
}
},
"openpitrixDescribeJobsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"job_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixJob"
}
}
}
},
"openpitrixJob": {
"type": "object",
"properties": {
"job_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"job_action": {
"type": "string"
},
"status": {
"type": "string"
},
"error_code": {
"type": "integer",
"format": "int64"
},
"directive": {
"type": "string"
},
"executor": {
"type": "string"
},
"task_count": {
"type": "integer",
"format": "int64"
},
"owner": {
"type": "string"
},
"provider": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateRepoRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
},
"selectors": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
},
"category_id": {
"type": "string"
}
}
},
"openpitrixCreateRepoResponse": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixDeleteReposRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteReposResponse": {
"type": "object",
"properties": {
"repo_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeReposResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepo"
}
}
}
},
"openpitrixModifyRepoRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
},
"selectors": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
},
"category_id": {
"type": "string"
}
}
},
"openpitrixModifyRepoResponse": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixRepo": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
},
"owner": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
},
"selectors": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"category_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixResourceCategory"
}
}
}
},
"openpitrixRepoLabel": {
"type": "object",
"properties": {
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
}
}
},
"openpitrixRepoSelector": {
"type": "object",
"properties": {
"selector_key": {
"type": "string"
},
"selector_value": {
"type": "string"
}
}
},
"openpitrixValidateRepoResponse": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"format": "boolean"
},
"errorCode": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixDescribeRepoEventsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_event_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoEvent"
}
}
}
},
"openpitrixIndexRepoRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixIndexRepoResponse": {
"type": "object",
"properties": {
"repo_event": {
"$ref": "#/definitions/openpitrixRepoEvent"
},
"repo_id": {
"type": "string"
}
}
},
"openpitrixRepoEvent": {
"type": "object",
"properties": {
"repo_event_id": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"result": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateRuntimeRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"provider": {
"type": "string"
},
"runtime_url": {
"type": "string"
},
"zone": {
"type": "string"
},
"runtime_credential": {
"type": "string"
},
"labels": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeResponse": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
}
}
},
"openpitrixDeleteRuntimesRequest": {
"type": "object",
"properties": {
"runtime_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteRuntimesResponse": {
"type": "object",
"properties": {
"runtime_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeRuntimeDetailsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_detail_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeDetail"
}
}
}
},
"openpitrixDescribeRuntimeProviderZonesResponse": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"zone": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeRuntimesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntime"
}
}
}
},
"openpitrixGetRuntimeStatisticsResponse": {
"type": "object",
"properties": {
"last_two_week_created": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"top_ten_providers": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"runtime_count": {
"type": "integer",
"format": "int64"
},
"provider_count": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixModifyRuntimeRequest": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"labels": {
"type": "string"
},
"runtime_credential": {
"type": "string"
}
}
},
"openpitrixModifyRuntimeResponse": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
}
}
},
"openpitrixRuntime": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"provider": {
"type": "string"
},
"runtime_url": {
"type": "string"
},
"zone": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeLabel"
}
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixRuntimeDetail": {
"type": "object",
"properties": {
"runtime": {
"$ref": "#/definitions/openpitrixRuntime"
},
"runtime_credential": {
"type": "string"
}
}
},
"openpitrixRuntimeLabel": {
"type": "object",
"properties": {
"runtime_label_id": {
"type": "string"
},
"runtime_id": {
"type": "string"
},
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateTaskResponse": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixDescribeTasksResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"task_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixTask"
}
}
}
},
"openpitrixRetryTasksRequest": {
"type": "object",
"properties": {
"task_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixRetryTasksResponse": {
"type": "object",
"properties": {
"task_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixTask"
}
}
}
},
"openpitrixTask": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"job_id": {
"type": "string"
},
"task_action": {
"type": "string"
},
"status": {
"type": "string"
},
"error_code": {
"type": "integer",
"format": "int64"
},
"directive": {
"type": "string"
},
"executor": {
"type": "string"
},
"owner": {
"type": "string"
},
"target": {
"type": "string"
},
"node_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"failure_allowed": {
"type": "boolean",
"format": "boolean"
}
}
}
}
}
`,
}
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.