Inspect Data Source Schemas via ListDataSourceSchemas API - OpenSearch - Alibaba Cloud - OpenSearch

Operation description

Method

GET

URI

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

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

searchengine:ListDataSourceSchemas

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
dataSourceName	string	Yes	The name of the data source.	ha-cn-pl32rf0****_test_api

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample requests

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

Response elements

Element	Type	Description	Example
	object	The results returned.
requestId	string	The request ID.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	The schema entries returned.
	array<object>	The schema information.
name	string	The field name.	id
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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.