All Products
Search

This Product

    OpenSearch:ListSchemas

    Document Center

    OpenSearch:ListSchemas

    Last Updated:Nov 04, 2025

    Retrieves a list of schemas based on a data synchronization configuration.

    Operation description

    Method

    GET

    URI

    /openapi/ha3/instances/{instanceId}/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:ListSchemas

    list

    *Instance

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

    		 None None

    Request syntax

    GET /openapi/ha3/instances/{instanceId}/schemas HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    type

    string

    Yes

    odps, swift, saro, oss, unknown

    odps
    endpoint

    string

    No

    The endpoint of the ODPS data source.

    http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
    accessKey

    string

    No

    The AccessKey ID of the ODPS data source.

    L***p
    accessSecret

    string

    No

    The alias of an ODPS data source.

    5**9a6
    project

    string

    No

    The name of the ODPS data source project.

    sec_odps
    partition

    string

    No

    The data partition.

    dt=20230520
    table

    string

    No

    The name of the table in the Saro or ODPS data source.

    item
    namespace

    string

    No

    The namespace of the Saro data source.

    imm
    instanceId

    string

    Yes

    The instance ID.

    ha-cn-pl32rf0****

    Response elements

    Element

    Type

    Description

    Example

    object

    requestId

    string

    The request ID.

    FE03180A-0E29-5474-8A86-33F0683294A4
    result

    any

    The response data.

    {}

    Examples

    Success response

    JSON format

    {
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": "{}"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.