UpdateRecallManagementTable

更新时间:
复制 MD 格式

Updates the configuration of a recall management table specified by its ID.

Operation description

Request details

  • Updates the recall management table specified by RecallManagementTableId.

  • You can enable fluctuation thresholds for the row count or data size and define the specific ranges for these thresholds.

  • You can add or modify fields in the table, including their names, types, and attributes.

  • The InstanceId parameter is required and identifies the specific instance.

  • For vector-related fields, you can also specify the vector dimension and metric type.

  • Note: Optional parameters in the request body selectively update the target table.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

RecallManagementTableId

string

Yes

The ID of the recall management table.

3

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

InstanceId

string

Yes

The instance ID.

pairec-cn-test123

EnableRowCountFluctuationThreshold

boolean

No

Specifies whether to enable the row count fluctuation threshold.

true

MinRowCountFluctuationThreshold

integer

No

The minimum value for the row count fluctuation threshold.

10

MaxRowCountFluctuationThreshold

integer

No

The maximum value for the row count fluctuation threshold.

100

EnableDataSizeFluctuationThreshold

boolean

No

Specifies whether to enable the data size fluctuation threshold.

true

MinDataSizeFluctuationThreshold

integer

No

The minimum value for the data size fluctuation threshold.

10

MaxDataSizeFluctuationThreshold

integer

No

The maximum value for the data size fluctuation threshold.

100

IndexVersionId

string

No

The version ID of the table.

20250701

Fields

object

No

A list of fields.

Name

string

No

The field name.

age

Type

string

No

The data type of the field.

STRING(全大写)

Attributes

array

No

Specifies the role of the field. Valid values:

  • Primary: The primary key field.

  • Item: The item field.

  • Score: The recall score field.

  • Vector: The vector field.

  • Index: The index field.

string

No

A field attribute.

Primary

VectorDimension

integer

No

The vector dimension.

32

VectorMetricType

string

No

The vector metric type.

L2

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77

Examples

Success response

JSON format

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.