文档

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

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:DeleteStopGatewaydelete
  • 全部资源
    *

请求参数

名称类型必填描述示例值
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.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史