ListDataSourceSchemas - OpenSearch - Alibaba Cloud Documentation Center

Queries the schema information about a data source.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-zvp2s4l8f02
dataSourceName	string	Yes	The name of the data source.	ha-cn-2r42ostoc01_ecom_table_test

Sample requests

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/schemas

Response parameters

Parameter	Type	Description	Example
	object	The results returned.
requestId	string	The ID of the request.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	The results returned.
	object	The schema information.
name	string	The field name.	test
custom	boolean	Indicates whether the field is a custom field. Valid values: true and false.	false
type	string	The field type.	STRING
attribute	boolean	Indicates whether the field is an attribute field. Valid values: true and false.	false
summary	boolean	Indicates whether the field can be displayed. Valid values: true and false.	false
primaryKey	object	The primary key field.
isPrimaryKey	boolean	Indicates whether the field is the primary key. Valid values: true and false.	false
hasPrimaryKeyAttribute	boolean	Indicates whether the field has the primary key attribute. Valid values: true and false.	false
isPrimaryKeySorted	boolean	Indicates whether the field can be sorted. Valid values: true and false.	false
addIndex	boolean	Indicates whether the field has the index attribute. Valid values: true and false.	false

Sample responses

Success responses

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result":[
    {
      "summary": false,
      "custom": false,
      "addIndex": false,
      "type": "INT64",
      "name": "id",
      "attribute": false,
      "primaryKey": {
        "hasPrimaryKeyAttribute": false,
        "primaryKeySorted": false,
        "primaryKey": false
      }
    },
    {
      "summary": false,
      "custom": false,
      "addIndex": false,
      "type": "STRING",
      "name": "fb_boolean",
      "attribute": false,
      "primaryKey": {
        "hasPrimaryKeyAttribute": false,
        "primaryKeySorted": false,
        "primaryKey": false
      }
    }
  ]
}

Examples

Sample success responses

JSONformat

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "name": "test",
      "custom": false,
      "type": "STRING",
      "attribute": false,
      "summary": false,
      "primaryKey": {
        "isPrimaryKey": false,
        "hasPrimaryKeyAttribute": false,
        "isPrimaryKeySorted": false
      },
      "addIndex": false
    }
  ]
}

Error codes

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