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

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
searchengine:ListDataSourceSchemas	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request syntax

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

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.
item	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.