diff --git a/docs/index.yaml b/docs/index.yaml index 9c3e2a19b2..133983ff62 100644 --- a/docs/index.yaml +++ b/docs/index.yaml @@ -295,6 +295,8 @@ paths: $ref: "./loadbalancer/loadbalanceragent-params-patch.yaml" /loadbalanceragents/{loadbalancerAgentId}/deploy: $ref: "./loadbalancer/loadbalanceragent-deploy.yaml" + /loadbalanceragents/{loadbalancerAgentId}/undeploy: + $ref: "./loadbalancer/loadbalanceragent-undeploy.yaml" /identity_providers: $ref: "./identity/identity_providers.yaml" @@ -498,4 +500,4 @@ paths: /cloudaccounts/{cloudaccountId}/enable-auto-sync: $ref: "./cloudaccount/enable-auto-sync.yaml" /cloudaccounts/{cloudaccountId}/disable-auto-sync: - $ref: "./cloudaccount/disable-auto-sync.yaml" \ No newline at end of file + $ref: "./cloudaccount/disable-auto-sync.yaml" diff --git a/docs/loadbalancer/loadbalanceragent-undeploy.yaml b/docs/loadbalancer/loadbalanceragent-undeploy.yaml new file mode 100644 index 0000000000..7a1f53297a --- /dev/null +++ b/docs/loadbalancer/loadbalanceragent-undeploy.yaml @@ -0,0 +1,18 @@ +post: + summary: 下线转发实例 + description: | + 该操作要求被下线的转发实例之前通过lbagent-deploy部署 + + 下线的执行操作包括 + + - 卸载lbagent + - 停止正在运行的与转发相关的守护进程 + parameters: + - $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId" + responses: + 200: + description: 变更后的转发实例信息 + schema: + $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" + tags: + - loadbalanceragents