文档

DeleteStopGateway - 删除已停止的DBGateway元数据

更新时间:

调用DeleteStopGateway接口,删除已停止的DBGateway元数据。

接口说明

  • 本接口用于删除 CreateCloudBenchTasks 接口创建的智能压测任务中已释放的 DBgateway 元数据。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
说明 当 DBGateway 与接入点超过 20 秒无心跳时,此 DBGateway 为停止状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
GatewayIdstring

DBGateway 的 ID,是 DBGateway 的唯一标识。可通过 DescribeCloudbenchTask 接口获取,返回的 ClientGatewayId 字段值即为 DBGateway 的 ID。

22938c83fcfbced4b4869b9695e3****

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Datastring

DBGateway 元数据删除结果:

  • 0:执行成功。
  • -1:系统错误。
  • -2:DBGateway 不存在。
  • -3:DBGateway 未停止,无法删除元数据。
  • -4:删除元数据信息失败。
0
RequestIdstring

请求 ID。

FC6C0929-29E1-59FD-8DFE-70D9D41E****
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "Data": "0",
  "RequestId": "FC6C0929-29E1-59FD-8DFE-70D9D41E****",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)