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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/assist/data-sources/[dataSourceType]/fields HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
params String Query Yes {}

The parameters about the data source. The value of the params parameter is a JSON string. The value must be URL-encoded.

The parameters for different types of data sources are different. For more information, see the following sections of the DataSource topic:

Response parameters

Parameter Type Example Description
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF
result Map {}

Examples

Sample requests

GET /v4/openapi/assist/data-sources/rds/fields?params=%7B%22db_name%22%3A%22mysql57%22%2C%22db_user%22%3A%22mysql57%22%2C%22db_password%22%3A%22opensearch_Rw%22%2C%22instance_id%22%3A%22rm-bp155vthpb6s99m34%22%2C%20%22db_table_name%22%3A%22dump%22%7D

Sample success responses

XML format

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <id>INT</id>
    <longname1>TEXT</longname1>
    <longname2>TEXT</longname2>
    <longname3>TEXT</longname3>
    <longname4>TEXT</longname4>
    <longname5>TEXT</longname5>
    <longname6>TEXT</longname6>
    <longname7>TEXT</longname7>
    <longname8>TEXT</longname8>
    <longname9>TEXT</longname9>
    <longname10>TEXT</longname10>
    <longname11>TEXT</longname11>
</result>

JSON format

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": {
        "id": "INT",
        "longname1": "TEXT",
        "longname2": "TEXT",
        "longname3": "TEXT",
        "longname4": "TEXT",
        "longname5": "TEXT",
        "longname6": "TEXT",
        "longname7": "TEXT",
        "longname8": "TEXT",
        "longname9": "TEXT",
        "longname10": "TEXT",
        "longname11": "TEXT"
    }
}

Error codes

For a list of error codes, visit the API Error Center.