获取合并后的宽表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
opensearch:GenerateMergedTable | get |
|
| 无 |
请求语法
POST /v4/openapi/assist/schema/actions/merge HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
spec | string | 否 | 目标版本规格(用于独享型特殊限制校验)。 默认:opensearch.share.common 参考:Quota 的 spec | "opensearch.share.common" |
body | Schema | 否 | 请求参数。 |
请求体
字段 | 类型 | 是否必要 | 示例值 | 描述 |
---|---|---|---|---|
tables | Object | 是 | 表结构 | |
indexes | Object | 否 | 索引结构 |
返回参数
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | String | 请求 ID |
result.mergeTable | Object | 合并后的宽表结果 键为字段名,值为字段详情 |
result.fromTable | Object | 源表信息 |
result.fromTable.tables | Object | 表信息 键为表名,值为表结构信息 |
result.fromTable.tables.* | Object | 键为字段名,值为字段详情 |
result.fromTable.master | String | 主表 |
result.fromTable.level | Object | 表层级信息,从 0 开始 键为表名,值为层级 |
result.fromTable.joinMap | Object | 外表连接信息 键为表名,值为外表连接信息 |
result.fromTable.joinMap.* | Object | 外表连接字段信息 键为字段,值为外表连接字段信息 |
result.primaryKey | String | 主键字段 |
TableFields
名称 | 类型 | 描述 |
---|---|---|
name | String | 字段名 |
type | String | 字段类型 参考:数据表字段 |
isPk | String | 是否为主键 0:否 1:是 |
isMulti | Integer | 是否为多值 0:否 1:是 |
isAttribute | Integer | 是否为属性字段 0:否 1:是 |
JoinMapFields
名称 | 类型 | 描述 |
---|---|---|
table | String | 外连表名 |
key | String | 外连表主键名 |
join | Object | 外连表的扩展字段 |
示例
正常返回示例
JSON
格式
{
"requestId": "ABCDEFGH",
"result": {
"primaryKey": "-",
"mergeTable": {
"test": "test",
"test2": 1
},
"fromTable": {
"test": "test",
"test2": 1
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-05-24 | OpenAPI 入参发生变更 | 查看变更详情 |