GetRecallManagementTable - 获取召回管理数据表详情

更新时间:
复制为 MD 格式

查询指定召回管理表的详细信息,包括表结构和配置等。

接口说明

请求说明

本接口用于根据给定的数据表 ID(RecallManagementTableId)和实例 ID(InstanceId),获取召回管理表的详细信息。请确保在请求时正确提供这两个参数值。

  • 注意CanDelete 字段表示该表是否支持删除操作,请谨慎处理相关逻辑。
  • Fields 列表中包含了表内字段的具体定义,如名称、类型及属性等重要信息。
  • 表的波动阈值设置(行数与大小)可通过相应字段进行配置或查询,以监控数据变化情况。

调试

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

授权信息

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

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

请求语法

GET /api/v1/recallmanagementtables/{RecallManagementTableId} HTTP/1.1

请求参数

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

数据表 ID。

3
InstanceIdstring

实例 ID。

pairec-cn-test123

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 id。

728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
RecallManagementTableIdstring

数据表 ID。

3
Namestring

数据表名。

table-123
Descriptionstring

数据表备注。

this is a test
Typestring

表类型。

Recall
RecallTypestring

表的召回类型。

X2I
DataSourcestring

数据源。

Api
MaxcomputeProjectNamestring

maxcompute 项目名。

test
MaxcomputeTableNamestring

maxcompute 中表名。

table-1
CanDeleteboolean

表是否可以被删除。

true
IndexVersionIdstring

索引版本 Id。

20250701
IndexEffectiveTimestring

索引生效时间

2021-12-15T23:24:33.132+08:00
Configstring

表的一些额外配置

{"item_id":""}
EnableRowCountFluctuationThresholdboolean

是否启动表数据条目波动阈值

true
MinRowCountFluctuationThresholdinteger

表数据条目波动阈值最小值

10
MaxRowCountFluctuationThresholdinteger

表数据条目波动阈值最大值

100
EnableDataSizeFluctuationThresholdboolean

是否启动表大小波动阈值

false
MinDataSizeFluctuationThresholdinteger

表大小波动阈值最小值

10
MaxDataSizeFluctuationThresholdinteger

表大小波动阈值最大值

100
GmtCreateTimestring

创建时间。

2021-12-15T23:24:33.132+08:00
GmtModifiedTimestring

更新时间。

2021-12-15T23:24:33.132+08:00
MaxcomputeSchemastring

maxcompute schema。

default
PartitionFieldsstring

表的分区字段。

dt
Fieldsarray<object>

字段列表。

Fieldsobject

字段详情。

Namestring

字段名称。

age
Typestring

字段类型。

STRING
Attributesarray

字段的属性列表。

Attributesstring

字段属性。

Primary
VectorDimensioninteger

向量维度。

32
VectorMetricTypestring

向量指标类型。

L2

示例

正常返回示例

JSON格式

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "RecallManagementTableId": 3,
  "Name": "table-123",
  "Description": "this is a test",
  "Type": "Recall",
  "RecallType": "X2I",
  "DataSource": "Api",
  "MaxcomputeProjectName": "test",
  "MaxcomputeTableName": "table-1",
  "CanDelete": true,
  "IndexVersionId": 20250701,
  "IndexEffectiveTime": "2021-12-15T23:24:33.132+08:00",
  "Config": {
    "item_id": ""
  },
  "EnableRowCountFluctuationThreshold": true,
  "MinRowCountFluctuationThreshold": 10,
  "MaxRowCountFluctuationThreshold": 100,
  "EnableDataSizeFluctuationThreshold": false,
  "MinDataSizeFluctuationThreshold": 10,
  "MaxDataSizeFluctuationThreshold": 100,
  "GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
  "GmtModifiedTime": "2021-12-15T23:24:33.132+08:00",
  "MaxcomputeSchema": "default",
  "PartitionFields": "dt",
  "Fields": [
    {
      "Name": "age",
      "Type": "STRING",
      "Attributes": [
        "Primary"
      ],
      "VectorDimension": 32,
      "VectorMetricType": "L2"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-01-13新增 OpenAPI查看变更详情