容器集群

SDK类名：/resource/ContainerCluster;

备份目标位置 - 新建

SDK方法名：createBackupDestination;

URL

/backup_destination

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
name	String		名称
cls_uuid	String		容器集群
sto_uuid	String		对象存储
bucket	String		对象桶
s3_real_address	Number		使用S3真实地址开关 1-勾选 0-不勾选
region	String		区域
check_sto_address	Number		校验对象存储地址开关 1-勾选 0-不勾选
sto_address_cert	String		对象存储地址根证书
copy_switch	Number		0 - 关 不勾选 1 - 开 勾选
src_uuid	String		源备份目标位置uuid
src_cls_uuid	String		源集群uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

备份目标位置 - 列表

SDK方法名：listBackupDestination;

URL

/backup_destination

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
total	Number			3	30
info_list	Array				30
uuid	String		备份目标位置uuid	@uuid
name	String		名称	aws-backup-location
cls_name	String		容器集群名	kubernetes1
cls_uuid	String		容器集群uuid	E679EF73-5288-E3C4-9608-B33B47416B87
sto_name	String		对象存储名称	aws
sto_uuid	String		对象存储uuid	E679EF73-5288-E3C4-9608-B33B47416B87
bucket	String		对象桶	vetero
region	String		区域	cn
user_uuid	String		用户uuid	E679EF73-5288-E3C4-9608-B33B47416B87
username	String		用户名	admin
can_del	Number		是否可删除	1
can_op	Number		是否可操作	1
can_up	Number		是否可修改	1

备份目标位置 - 单个

SDK方法名：descibeBackupDestination;

URL

/backup_destination/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
backup_destination	Object
uuid	String
name	String			@first
cls_uuid	String
sto_uuid	String
random_str	String
user_uuid	String
username	String			admin
create_time	Number			0
s3_real_address	Number			1
bucket	String			@last
region	String			cn
check_sto_address	Number			1
sto_address_cert	String			@name

备份目标位置 - 修改

SDK方法名：modifyBackupDestination;

URL

/backup_destination/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String
name	String
cls_uuid	String
sto_uuid	String
random_str	String
s3_real_address	Number			1
bucket	String
region	String
check_sto_address	Number			1
sto_address_cert	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

备份目标位置 - 删除

SDK方法名：deleteBackupDestination;

URL

/backup_destination

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

备份目标位置 - 状态

SDK方法名：listBackupDestinationStatus;

URL

/backup_destination/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	String
force_refresh	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
status	Array
uuid	String			E95CB20B-917C-57F4-F926-751ECE95F869
status	String		有效-VALID 无效-INVALID	VALID
last_synced_time	Number
last_validation_time	Number
time	Number

容器集群 - 集群信息

SDK方法名：listContainerClusterInfo;

URL

/container_cluster/cls_info

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_config	Object		【可选】新加容器界面传，容器集群配置文件，将文件内容存入到该字段中，是一个yml文件
username	String		【可选】新加容器界面传，用户
password	String		【可选】新加容器界面传，密码
component_namespace	String		【可选】新加容器界面传，备份组件名字空间，默认info2soft
net_type	String		【可选】新加容器界面传，备份组件访问方式: ingress, lb
cls_uuid	String		【可选】备份目标位置界面点击认证时传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
cls_info	Object
component_version	String		组件版本
cls_version	String		集群版本
cls_component_config	Object
cpu_limit	Number
cpu_request	Number
mem_limit	Number
mem_request	Number
pv_component_config	Object
cpu_limit	Number
cpu_request	Number	否
mem_limit	Number
mem_request	Number

容器集群 - 同步信息

SDK方法名：syncContainerClusterInfo;

URL

/container_cluster/sync_info

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_uuid	String
type	String		备份目标位置 - backup_destination 备份 - backup 还原 - recovery

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

容器集群 - 资源信息

SDK方法名：listContainerClusterResource;

URL

/container_cluster/resource

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
resource	Object
configmaps	Object
items	Array			["kube-root-ca.crt"]
name	String			configmaps
num	Number			0
endpoints	Object
items	Array			["i2node"]
name	String			endpoints
num	Number			0
events	Object
items	Array
name	String			events
num	Number			0
limitranges	Object
items	Array
name	String			limitranges
num	Number			0
persistentvolumeclaims	Object
items	Array			["i2node-credentials","i2node-logs","i2node-yamls"]
name	String			persistentvolumeclaims
num	Number			2
pods	Object
items	Array			["i2bcc-create-stxvz","i2node-5dd8574bbf-jnwc8","restic-5hskl","restic-6w495","restic-dkmwc","restic-rrbwz","velero-87dd87f6c-wqfdc"]
name	String			pods
num	Number			6
podtemplates	Object
items	Array
name	String			podtemplates
num	Number			0
replicationcontrollers	Object
items	Array
name	String			replicationcontrollers
num	Number			0
resourcequotas	Object
items	Array
name	String			resourcequotas
num	Number			0
secrets	Object
items	Array			["cloud-credentials","i2node-admin","info2conf","mytest","velero-restic-credentials"]
name	String			secrets
num	Number			4
serviceaccounts	Object
items	Array			["default","i2node-admin","velero"]
name	String			serviceaccounts
num	Number			2
services	Object
items	Array			["i2node"]
name	String			services
num	Number			0
controllerrevisions.apps	Object
items	Array			["restic-548cc8f877"]
name	String			controllerrevisions.apps
num	Number			0
daemonsets.apps	Object
items	Array			["restic"]
name	String			daemonsets.apps
num	Number			0
deployments.apps	Object
items	Array			["i2node","velero"]
name	String			deployments.apps
num	Number			1
replicasets.apps	Object
items	Array			["i2node-5dd8574bbf","velero-87dd87f6c"]
name	String			replicasets.apps
num	Number			1
statefulsets.apps	Object
items	Array
name	String			statefulsets.apps
num	Number			0
horizontalpodautoscalers.autoscaling	Object
items	Array
name	String			horizontalpodautoscalers.autoscaling
num	Number			0
cronjobs.batch	Object
items	Array
name	String			cronjobs.batch
num	Number			0
jobs.batch	Object
items	Array			["i2bcc-create"]
name	String			jobs.batch
num	Number			0
leases.coordination.k8s.io	Object
items	Array
name	String			leases.coordination.k8s.io
num	Number			0
endpointslices.discovery.k8s.io	Object
items	Array			["i2node-gvwbm"]
name	String			endpointslices.discovery.k8s.io
num	Number			0
events.events.k8s.io	Object
items	Array
name	String			events.events.k8s.io
num	Number			0
ingresses.networking.k8s.io	Object
items	Array			["i2node-ingress"]
name	String			ingresses.networking.k8s.io
num	Number			0
networkpolicies.networking.k8s.io	Object
items	Array
name	String			networkpolicies.networking.k8s.io
num	Number			0
poddisruptionbudgets.policy	Object
items	Array
name	String			poddisruptionbudgets.policy
num	Number			0
rolebindings.rbac.authorization.k8s.io	Object
items	Array
name	String			rolebindings.rbac.authorization.k8s.io
num	Number			0
roles.rbac.authorization.k8s.io	Object
items	Array
name	String			roles.rbac.authorization.k8s.io
num	Number			0
csistoragecapacities.storage.k8s.io	Object
items	Array
name	String			csistoragecapacities.storage.k8s.io
num	Number			0
backups.velero.io	Object
items	Array
name	String			backups.velero.io
num	Number			0
backupstoragelocations.velero.io	Object
items	Array			["mytest"]
name	String			backupstoragelocations.velero.io
num	Number			0
deletebackuprequests.velero.io	Object
items	Array
name	String			deletebackuprequests.velero.io
num	Number			0
downloadrequests.velero.io	Object
items	Array
name	String			downloadrequests.velero.io
num	Number			0
podvolumebackups.velero.io	Object
items	Array
name	String			podvolumebackups.velero.io
num	Number			0
podvolumerestores.velero.io	Object
items	Array
name	String			podvolumerestores.velero.io
num	Number			0
resticrepositories.velero.io	Object
items	Array
name	String			resticrepositories.velero.io
num	Number			0
restores.velero.io	Object
items	Array
name	String			restores.velero.io
num	Number			0
schedules.velero.io	Object
items	Array
name	String			schedules.velero.io
num	Number			0
serverstatusrequests.velero.io	Object
items	Array
name	String			serverstatusrequests.velero.io
num	Number			0
volumesnapshotlocations.velero.io	Object
items	Array
name	String			volumesnapshotlocations.velero.io
num	Number			0

容器集群 - 名字空间

SDK方法名：listContainerClsNamespace;

URL

/container_cluster/namespace

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_uuid	String			58ECEEB7-D4FC-4746-A507-AA3BBC98EFD1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
namespace	Object
default	Object
createtime	String			2022-10-28T03:29:46Z
name	String			default
status	String			Active
info2soft	Object
createtime	String			2022-11-15T03:11:28Z
name	String			info2soft
status	String			Active
ingress-nginx	Object
createtime	String			2022-11-01T02:12:02Z
name	String			ingress-nginx
status	String			Active
kube-node-lease	Object
createtime	String			2022-10-28T03:29:45Z
name	String			kube-node-lease
status	String			Active
kube-public	Object
createtime	String			2022-10-28T03:29:45Z
name	String			kube-public
status	String			Active
kube-system	Object
createtime	String			2022-10-28T03:29:45Z
name	String			kube-system
status	String			Active
metallb-system	Object
createtime	String			2022-10-31T06:47:15Z
name	String			metallb-system
status	String			Active
mytest	Object
createtime	String			2022-11-14T07:09:38Z
name	String			mytest
status	String			Active
nfs-storage	Object
createtime	String			2022-10-31T03:02:03Z
name	String			nfs-storage
status	String			Active
nginx	Object
createtime	String			2022-11-10T03:09:51Z
name	String			nginx
status	String			Active
nginx-example	Object
createtime	String			2022-10-31T06:49:05Z
name	String			nginx-example
status	String			Active
number	Number			0

容器集群-概览-状态

SDK方法名：containerClusterMonitoringOverview;

URL

/v3/container_cluster/monitoring/overview

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_uuid	String	是	集群UUID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			xxx
name	String			dev
uid	String			614842d0-43ff-42a4-81a3-0a9244aa6fa0
node_count	Number			6
version	String			v1.22.10
expire_date	String			2023-11-21T09:37:08Z
create_date	String			2021-11-21T09:37:08Z
metrics	Array				11
metric_name	Array		cluster_pod_running_count 容器组 总计 cluster_pod_quota 容器组 已使用 cluster_cpu_total CPU总计 cluster_cpu_usage CPU已使用 cluster_memory_total 内存总计 cluster_memory_usage_wo_cache 内存已使用 cluster_disk_size_capacity 磁盘总价 cluster_disk_size_usage 磁盘已用 apiserver_request_latencies API请求延迟 apiserver_request_rate API每秒请求数 scheduler_schedule_attempts 调度次数	["cluster_pod_running_count","cluster_cpu_total","cluster_memory_usage_wo_cache","cluster_pod_quota","cluster_disk_size_capacity","cluster_cpu_usage","cluster_memory_total","cluster_disk_size_usage","apiserver_request_latencies","apiserver_request_rate","scheduler_schedule_attempts"]	+1
data	Object
resultType	String			vector
result	Array
metric	Object
name	String			cluster:pod_running:count
value	Array			[1668578686.689, "30"]
min_value	String
max_value	String
avg_value	String
sum_value	String
fee	String
resource_unit	String
currency_unit	String

容器集群-概览-节点

SDK方法名：containerClusterMonitoringNode;

URL

/v3/container_cluster/monitoring/node

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则

容器集群 - 新建

SDK方法名：createContainerCluster;

URL

/container_cluster

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_name	String		容器集群名称
cls_type	Number		容器集群类型：预留字段 0-kubernets集群
component_namespace	String		备份组件名字空间，默认info2soft
cls_config	String		容器集群配置文件，将文件内容存入到该字段中，是一个yml文件，后端存入表中
cls_version	String		容器集群版本
component_version	String		备份组件版本
component_settings	Object		备份组件资源管理
cls_component_config	Object		容器集群备份组件资源管理
cpu_limit	Number		备份组件 cpu限制
cpu_request	Number		备份组件 cpu请求
mem_limit	Number		备份组件 内存限制
mem_request	Number		备份组件 内存请求
pv_component_config	Object		pv备份组件资源管理
cpu_limit	Number		pv备份组件 cpu限制
cpu_request	Number		pv备份组件 cpu请求
mem_limit	Number		pv备份组件 内存限制
mem_request	Number		pv备份组件 内存请求
os_user	String		用户
os_pwd	String		密码
net_type	String		备份组件访问方式: ingress, lb

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

容器集群 - 列表

SDK方法名：listContainerCluster;

URL

/container_cluster

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
total	Number			3	40
info_list	Array				40
cls_uuid	String		容器集群uuid	E679EF73-5288-E3C4-9608-B33B47416B87
cls_name	String		容器集群名称	cls-@first()
cls_version	String		容器集群版本	kubernetes v1.24.3
component_version	String		备份组件版本	v1.0.0
os_user	String		授权信息	k-admin
username	String			admin
can_del	Number			1
can_op	Number			1
can_up	Number			1
is_biz_admin	Number			1

容器集群 - 单个

SDK方法名：describeContainerCluster;

URL

/container_cluster/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
container_cluster	Object
cls_name	String			@first
cls_uuid	String
user_uuid	String			@uuid
random_str	String			@title
os_user	String			@last
os_pwd	String
cls_version	String
component_settings	Object
cls_component_config	Object
cpu_limit	Number			1
cpu_request	Number			1
mem_limit	Number			500
mem_request	Number			1
pv_component_config	Object
cpu_limit	Number			1
cpu_request	Number			1200
mem_limit	Number			1
mem_request	Number			1
component_version	String
net_type	String
create_time	String
username	String

容器集群 - 修改

SDK方法名：modifyContainerCluster;

URL

/container_cluster/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_name	String
cls_config	Object
component_settings	Object
cls_component_config	Object
cpu_limit	Number			1
cpu_request	Number			1
mem_limit	Number			1
mem_request	Number			1
pv_component_config	Object
cpu_limit	Number			1
cpu_request	Number			1
mem_limit	Number			1
mem_request	Number			1
component_version	String
current_context	String
cls_version	String
authorization_info	String
random_str	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则

容器集群 - 删除

SDK方法名：deleteContainerCluster;

URL

/container_cluster

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_uuids	Array
force	Number		强制删除： 0 - 非强制删除 1 - 强制删除

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

回调设置 - 新建

SDK方法名：createCallbackSettings;

URL

/callback_settings

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
name	String		脚本名称
type	Number		回调类型： 0-备份回调 1-还原回调
cls_uuid	String		容器集群
pod	String		pod选择
before_backup	Array		备份前
cmd	String		执行命令
container	String		执行容器
error_handling	String		错误处理 Fail and Continue
timeout	String		超时
after_backup	Array		备份后
cmd	String		执行命令
container	String		执行容器
error_handling	String		错误处理
timeout	String		超时
init_container	Array		初始化容器命令
name	String		加载容器名称
mirror	String		加载容器镜像
cmd	String		执行命令
volume	String		加载卷
recovery_callback	Array		还原回调命令
container	String		执行容器
cmd	String		执行命令
error_handling	String		错误处理
exec_timeout	Number		执行超时
wait_timeout	Number		等待超时

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

回调设置 - 列表

SDK方法名：listCallbackSettings;

URL

/callback_settings

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
where_args[type]	Number

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
total	Number			3
info_list	Array
name	String			@last
type	Number			1
cls_uuid	String			@uuid
cls_name	String			@first
pod	String			@word
uuid	String			@uuid
user_uuid	String			E679EF73-5288-E3C4-9608-B33B47416B87
username	String			admin
can_del	Number			1
can_op	Number			1
can_up	Number			1
before_backup	Array				5
cmd	String			/sbin/fsfreeze' , "--freeze' '，*/var/log/nginx-@first
container	String
error_handling	String
timeout	String
after_backup	Array				2
cmd	String			/sbin/fsfreeze' , "--freeze' '，*/var/log/apache-@word
container	String
error_handling	String
timeout	String
init_container	Array
name	String
mirror	String
cmd	String
volume	String
recovery_callback	Array
container	String
cmd	String
error_handling	String
exec_timeout	Number			1
wait_timeout	Number			1

回调设置 - 单个

SDK方法名：describeCallbackSettings;

URL

/callback_settings/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
callback_settings	Object
name	String
type	Number			1
cls_uuid	String
pod	String
uuid	String			@uuid
user_uuid	String			E679EF73-5288-E3C4-9608-B33B47416B87
username	String			admin
random_uuid	String			E679EF73-5288-E3C4-9608-B33B47416B87
before_backup	Array
cmd	String
container	String
error_handling	String
timeout	String
after_backup	Array
cmd	String
container	String
error_handling	String
timeout	String
init_container	Array
name	String
mirror	String
cmd	String
volume	String
recovery_callback	Array
container	String
cmd	String
error_handling	String
exec_timeout	Number			1
wait_timeout	Number			1

回调设置 - 修改

SDK方法名：modifyCallbackSettings;

URL

/callback_settings/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
name	String
type	Number			1
cls_uuid	String
pod	String
uuid	String			@uuid
user_uuid	String			E679EF73-5288-E3C4-9608-B33B47416B87
username	String			admin
random_uuid	String			E679EF73-5288-E3C4-9608-B33B47416B87
before_backup	Array
cmd	String
container	String
error_handling	String
timeout	String
after_backup	Array
cmd	String
container	String
error_handling	String
timeout	String
init_container	Array
name	String
mirror	String
cmd	String
volume	String
recovery_callback	Array
container	String
cmd	String
error_handling	String
exec_timeout	Number			1
wait_timeout	Number			1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

回调设置 - 删除

SDK方法名：deleteCallbackSettings;

URL

/callback_settings

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

回调设置 - 操作

SDK方法名：{operate}CallbackSettings;

URL

/callback_settings/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String		克隆 - clone
uuids	Array

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。

回调设置 - 验证

SDK方法名：verifyCallbackSettingsPod;

URL

/callback_settings/pod_verify

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
cls_uuid	String
pod	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
list	Array			[ "nginx-example\nginx-deployment-77ddf7df75-pmxjn:Running", "nginx\nginx-deployment-77ddf7df75-pmxjn:Running"]