更新时间:2025-05-19 GMT+08:00
分享

删除共享链接

功能介绍

用于删除共享链接。

调试

您可以在API Explorer中调试该接口。

URI

DELETE /v3/{project_id}/connections/share

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

shared_conn_id

String

参数解释:

共享连接ID。用户使用数据库账号与数据库建立的连接ID(数据库用户ID由创建实例连接接口创建)。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字、中划线组成,且长度为36个字符的UUID。

默认取值:

不涉及

users

Array of ShareConnUserInfo objects

参数解释:

用户。

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

表3 ShareConnUserInfo

参数

是否必选

参数类型

描述

user_id

String

参数解释:

用户ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

user_name

String

参数解释:

用户名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

无。

请求示例

删除共享链接。

DELETE https://{{endpoint}}/v3/{{project_id}}/connections/share 
{ 
  "users" : [ { 
    "user_id" : "0852a89ae180d5401f5ac00271a4a02e", 
    "user_name" : "username1" 
  }, { 
    "user_id" : "07da4af00180d5651f49c00200b352b5", 
    "user_name" : "username2" 
  } ], 
  "shared_conn_id" : "ee64e597-4f25-486f-bba1-0c850b3b59d6" 
}

响应示例

无。

状态码

状态码

描述

200

Success.

400

BadRequest.

500

InternalServerError.

错误码

请参见错误码

相关文档

    OSZAR »