GetAgenticTableIndex-阿里云帮助中心

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 parameters

Parameter	Type	Required	Description	Example
DatabaseUuid	string	Yes	The UUID of the database to which the table belongs. You can obtain this value by calling ListAgenticDatabase or SearchAgenticDatabase.	md-HZ-fp9K7r***
TableQualifiedName	string	Yes	The fully qualified name of the table. You can obtain this value from the QualifiedName parameter returned by ListAgenticTableBaseInfo. You must specify the full name.	orders

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	array	The list of indexes.
	AgenticTableIndex	The index information.
ErrorCode	string	The error code returned when a request exception occurs.	UnknownError
ErrorMessage	string	The error message returned when the call fails.	UnknownError
RequestId	string	The request ID.	67E910F2-4B62-5B0C-ACA3-7547695C****
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "Data": [
    {
      "ColumnNames": [
        "user_id"
      ],
      "Description": "Index on user_id",
      "IndexName": "idx_user_id",
      "IndexType": "Normal",
      "Primary": false,
      "RealColumnNames": [
        "user_id"
      ],
      "Unique": false
    }
  ],
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.