GetDatabaseSchema - OpenSearch - Alibaba Cloud Documentation Center

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema

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

searchengine:GetDatabaseSchema

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance.	ha-cn-pl32rf0****
database	string	Yes	The name of the database.	general
tableName	string	Yes	The name of the table.	graph_index_summary_

Response elements

Element	Type	Description	Example
	object
requestId	string	The ID of the request.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	The result.
	object	The result.
fieldName	string	The name of the field.	id
fieldType	string	The type of the field.	STRING
indexName	string	The name of the index.	test_tusou_v2
indexType	string	The type of the index.	NUMBER
fieldTypeDetail	object	The details of the field type.	FT_UINT64

Examples

Success response

JSON format

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "fieldName": "id",
      "fieldType": "STRING",
      "indexName": "test_tusou_v2",
      "indexType": "NUMBER",
      "fieldTypeDetail": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.