Query Table Fields with ListDataSourceTableFields - OpenSearch - Alibaba Cloud - OpenSearch

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

opensearch:ListDataSourceTableFields

get

*All Resource

*

None

Request syntax

GET /v4/openapi/assist/data-sources/{dataSourceType}/fields HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
dataSourceType	string	Yes	The data source type. rds polardb odps mysql drds Valid values: rds : rds mysql : mysql odps : odps saro : saro polardb : polardb	rds

Request parameters

Parameter	Type	Required	Description	Example
params	string	Yes	The data source parameters. A JSON string that must be URL-encoded. The parameters vary by data source type. For more information, see: rds polardb odps mysql drds	{}
rawType	boolean	No	Specifies whether to return the original field types of the data source.	false
zoneId	string	No

Response elements

Element	Type	Description	Example
	object	The response body.	{}
result	object	The collection of data source tables.	{}
requestId	string	The ID that uniquely identifies the request.	0A6EB64B-B4C8-CF02-810F-E660812972FF

Examples

Success response

JSON format

{
  "result": {},
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.