ListDataSourceTableFields - OpenSearch - Alibaba Cloud Documentation Center

Queries all fields in a table of a data source. This operation is for internal use only.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:ListDataSourceTableFields	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
dataSourceType	string	Yes	The type of the data source. Valid values: rds polardb odps mysql drds Enumeration Value: rds: rds. mysql: mysql. odps: odps. saro: saro. polardb: polardb.	rds
params	string	Yes	The parameters of the data source. The value of the params parameter is a JSON string. The value must be URL-encoded. Different types of data sources use different parameters. For more information, see the following sections of the "DataSource" topic: rds polardb odps mysql drds	{}
rawType	boolean	No	Specifies whether to return the original field types of the data source.	false

Response parameters

Parameter	Type	Description	Example
	object	The response body.
result	object	The returned result.	{}
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details