全部产品
Search
文档中心

云数据库 OceanBase:DeleteTenants - 删除租户

更新时间:Oct 23, 2024

删除指定 OceanBase 集群下的一个或多个租户。

调试

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

授权信息

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

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

请求参数

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

租户的 TenantId 列表。
其为 JSON 格式的数组,数组中每个对象均为租户名称的字符串。

["ob2mr3oae0****", "ob2mr3oae1****"]
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantIdsarray

租户的 ID 列表。

TenantIdsstring

租户的 ID。

tjd3da45kc****

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TenantIds": [
    "tjd3da45kc****"
  ]
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.内部错误

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

变更历史

变更时间变更内容概要操作
2021-11-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情