All Products
Search
Document Center

OpenSearch:ListDataSourceTableFields

Last Updated:Mar 03, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:ListDataSourceTableFieldsRead
  • All Resources
    *
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
dataSourceTypestringYes

The type of the data source. Valid values:

  • rds
  • polardb
  • odps
  • mysql
  • drds
rds
paramsstringYes

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:

{}
rawTypebooleanNo

Whether to return the original field type of the data source

false

Response parameters

ParameterTypeDescriptionExample
object

The response body.

resultobject

The returned result.

{}
requestIdstring

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 timeSummary of changesOperation
2023-05-24The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: rawType