GetRecallManagementTable-阿里云帮助中心

Queries the details of a specified recall management table, including the table schema and configurations.

Operation description

Request description

This operation retrieves the details of a recall management table based on the specified table ID (RecallManagementTableId) and instance ID (InstanceId). Make sure to provide valid values for these two parameters in the request.

Note: The CanDelete field indicates whether the table supports deletion. Handle the related logic with caution.
The Fields list contains the specific definitions of the fields in the table, such as the name, type, and attributes.
The fluctuation threshold settings for the table (row count and size) can be configured or queried through the corresponding fields to monitor data changes.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:GetRecallManagementTable

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
RecallManagementTableId	string	Yes	The table ID.	3

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	pairec-cn-test123

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
RecallManagementTableId	string	The table ID.	3
Name	string	The table name.	table-123
Description	string	The table description.	this is a test
Type	string	The table type.	Recall
RecallType	string	The recall type of the table.	X2I
DataSource	string	The data source.	Api
MaxcomputeProjectName	string	The name of the MaxCompute project.	test
MaxcomputeTableName	string	The name of the table in MaxCompute.	table-1
CanDelete	boolean	Indicates whether the table can be deleted.	true
IndexVersionId	string	The index version ID.	20250701
IndexEffectiveTime	string	The effective period of the index. The time is displayed in ISO 8601 format and includes the time zone offset.	2021-12-15T23:24:33.132+08:00
Config	string	The additional configurations of the table.	{"item_id":""}
EnableRowCountFluctuationThreshold	boolean	Indicates whether the fluctuation threshold for the row count of the table is enabled.	true
MinRowCountFluctuationThreshold	integer	The minimum fluctuation threshold for the row count of the table.	10
MaxRowCountFluctuationThreshold	integer	The maximum fluctuation threshold for the row count of the table.	100
EnableDataSizeFluctuationThreshold	boolean	Indicates whether the fluctuation threshold for the size of the table is enabled.	false
MinDataSizeFluctuationThreshold	integer	The minimum fluctuation threshold for the size of the table.	10
MaxDataSizeFluctuationThreshold	integer	The maximum fluctuation threshold for the size of the table.	100
GmtCreateTime	string	The creation time. The time is displayed in ISO 8601 format and includes the time zone offset.	2021-12-15T23:24:33.132+08:00
GmtModifiedTime	string	The update time. The time is displayed in ISO 8601 format and includes the time zone offset.	2021-12-15T23:24:33.132+08:00
MaxcomputeSchema	string	The MaxCompute schema.	default
PartitionFields	string	The partition fields of the table.	dt
Fields	array<object>	The list of fields.
	object	The field details.
Name	string	The field name.	age
Type	string	The field type.	STRING
Attributes	array	The list of attributes for the field.
	string	The field attribute.	Primary
VectorDimension	integer	The vector dimensions.	32
VectorMetricType	string	The vector metric type.	L2

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.