全部产品
Search
文档中心

云数据库 OceanBase (文档停止维护):DescribeTenantTags - 查询租户标签值

更新时间:Aug 28, 2026

该接口用于查询租户的标签值。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oceanbase:DescribeTenantTags

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

OceanBase 集群 ID。

ob317v4uif****

TenantIds

string

租户 ID 的数组字符串。

["t5r0x2f6q****", "t33h8y08k****", "t5r41rtl7****"]

Tags

string

标签值。

[{"Key": "xxx", "Value", "xxx"}]

返回参数

名称

类型

描述

示例值

object

请求的返回结果。

RequestId

string

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

TagResources

array<object>

标签列表。

object

请求的返回结果。

ResourceId

string

资源 ID。

ob317v4uif****

ResourceType

string

资源类型。

instance

Tag

string

资源标签。

[{"Key": "xxx", "Value", "xxx"},{}]

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TagResources": [
    {
      "ResourceId": "ob317v4uif****",
      "ResourceType": "instance",
      "Tag": "[{\"Key\": \"xxx\", \"Value\", \"xxx\"},{}]"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情