全部产品
Search

搜索本产品

    云数据库 OceanBase：DescribeTenants - 查询集群下的租户列表信息

    文档中心

    云数据库 OceanBase：DescribeTenants - 查询集群下的租户列表信息

    更新时间：Oct 29, 2024

    查询指定 OceanBase 集群列表下的租户列表信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    Oceanbase 集群 ID。

    		ob317v4uif****
    TenantNamestring否

    租户名称。
    长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。

    		pay_online
    PageSizeinteger否

    分页查询时设置的每页行数。

    • 最大值：100
    • 默认值：10
    		10
    PageNumberinteger否

    分页查询的页码。

    • 起始值：1。
    • 默认值：1。
    		1
    TenantIdstring否

    租户 ID。

    		ob2mr3oae0****
    SearchKeystring否

    查询列表的筛选关键字。

    		pay

    返回参数

    名称类型描述示例值
    object

    请求的返回结果。

    TotalCountinteger

    查询到的指定 OceanBase 集群的租户总数。

    		1
    RequestIdstring

    请求 ID。

    		EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    Tenantsarray<object>

    租户的列表信息。

    Dataobject

    租户的列表信息。

    VpcIdstring

    专有网络（VPC） ID。
    如无合适的 VPC，请根据页面提示创建一个 VPC，详情参见什么是专有网络。

    		vpc-bp1d2q3mhg9i23ofi****
    Statusstring

    租户的状态。

    • PENDING_CREATE: 创建中
    • RESTORE: 恢复中
    • ONLINE: 运行中
    • SPEC_MODIFYING: 规格修改中
    • ALLOCATING_INTERNET_ADDRESS: 公网地址分配中
    • PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中
    • PRIMARY_ZONE_MODIFYING: 切主可用区中
    • PARAMETER_MODIFYING: 参数修改中
    • WHITE_LIST_MODIFYING: 白名单修改中
    		ONLINE
    PrimaryZonestring

    租户的主可用区。

    		cn-hangzhou-i
    DeployTypestring

    租户的部署类型。

    • multiple：多机房
    • single：单机房
    • dual：双机房
    		multiple
    DeployModestring

    租户的数据副本模式。

    • 对于高可用版本：三地域为 N-N-N，两可用区和单可用区均为 N-N；
    • 对于基础版为 N。
    说明
    其中，N 为单可用区内的节点数。
    		1-1-1
    CreateTimestring

    租户的创建时间。

    		2021-09-17 15:52:17.0
    TenantNamestring

    租户名称。

    		pay_online
    Meminteger

    租户总的内存大小，单位：GB。

    		20
    Cpuinteger

    租户总的 CPU 核数，单位：Core。

    		10
    Descriptionstring

    租户描述信息。

    		paycore database
    TenantModestring

    租户模式。
    当前支持：

    • Oracle：Oracle 模式；
    • MySQL: MySQL 模式。
    		Oracle
    TenantIdstring

    租户 ID。

    		t33h8y08k****
    UnitCpuinteger

    租户每个 Unit 的 CPU 核数，单位：Core。

    		5
    UnitMeminteger

    租户每个 Unit 的内存大小，单位：GB。

    		10
    UnitNuminteger

    租户的 unit 个数。

    		2
    UsedDiskSizedouble

    租户已使用磁盘量。

    		10
    Charsetstring

    字符集

    		utf8mb4
    Collationstring

    字符序

    		utf8mb4_general_ci
    ParameterTemplatestring

    参数模板

    		express_oltp

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Tenants": [
    {
      "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
      "Status": "ONLINE",
      "PrimaryZone": "cn-hangzhou-i",
      "DeployType": "multiple",
      "DeployMode": "1-1-1",
      "CreateTime": "2021-09-17 15:52:17.0",
      "TenantName": "pay_online",
      "Mem": 20,
      "Cpu": 10,
      "Description": "paycore database",
      "TenantMode": "Oracle",
      "TenantId": "t33h8y08k****",
      "UnitCpu": 5,
      "UnitMem": 10,
      "UnitNum": 2,
      "UsedDiskSize": 10,
      "Charset": "utf8mb4",
      "Collation": "utf8mb4_general_ci",
      "EnableReadOnlyReplica": true,
      "ParameterTemplate": "express_oltp"
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-02-02OpenAPI 返回结构发生变更查看变更详情
    2022-09-28OpenAPI 返回结构发生变更查看变更详情
    2022-01-17OpenAPI 返回结构发生变更查看变更详情
    2021-08-19OpenAPI 返回结构发生变更查看变更详情