文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据脱敏/ 获取租户名下所有ES的type列表 - ListTypes
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取租户名下所有ES的type列表 - ListTypes

功能介绍

获取租户名下所有ES的type列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/server/mask/bigdata/es/indexes/types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

ins_id

String

参数解释：

实例ID

取值范围：

不涉及

ins_name

String

参数解释：

实例名称

取值范围：

不涉及

index_list

Array of IndexList objects

参数解释：

索引列表列表

取值范围：

不涉及

db_id

String

参数解释：

数据库ID

取值范围：

不涉及

index_name

String

参数解释：

索引名称

取值范围：

不涉及

types

Array of strings

类型列表
表4 IndexList

参数

参数类型

描述

db_id

String

参数解释：

数据库ID

取值范围：

不涉及

index_name

String

参数解释：

索引名称

取值范围：

不涉及

types

Array of strings

参数解释：

索引类型列表

取值范围：

不涉及

请求示例

获取租户名下所有ES的type列表

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/server/mask/bigdata/es/indexes/types

响应示例

状态码：200

{
  "ins_id" : "00000000-0000-0000-0000-000000000000",
  "ins_name" : "实例1",
  "index_list" : [ {
    "db_id" : "00000000-0000-0000-0000-000000000000",
    "index_name" : "索引1",
    "types" : [ "type1" ]
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 数据脱敏

相关文档