App data structure-OpenSearch(Open Search)-阿里云帮助中心

An App object represents a version of an OpenSearch application. The API returns this object in response to application version queries. Use the fields to check the application status, inspect the schema, and understand how ranking and query analysis are configured.

Example

The following example shows the top-level structure of an App object. Nested objects such as firstRanks and queryProcessors are shown as empty arrays here; see the linked references for their full schemas.

{
    "id": "100303063",
    "description": "",
    "status": "ok",
    "fetchFields": [
        "id",
        "title",
        "buy",
        "cate_id",
        "cate_name"
    ],
    "type": "enhanced",
    "schema": { },
    "algoDeploymentId": 0,
    "progressPercent": 100,
    "created": 1590977140,
    "firstRanks": [],
    "secondRanks": [],
    "dataSources": [],
    "summaries": [],
    "queryProcessors": []
}

Fields

Field	Type	Description
`id`	String	The ID of the version.
`description`	String	The description of the version.
`status`	String	The status of the version. See Status values.
`fetchFields`	Array	The default display fields.
`type`	String	The type of the version. See Type values.
`schema`	Object	The schema of the application. See Schema.
`algoDeploymentId`	Integer	The ID of the rough sort expression.
`progressPercent`	Integer	The progress of data import, as a percentage. For example, `83` means 83%.
`created`	Integer	The Unix timestamp when the version was created.
`firstRanks[]`	Object	The rough sort expressions. See FirstRank.
`secondRanks[]`	Object	The fine sort expressions. See SecondRank.
`dataSources[]`	Object	The data sources. See DataSource.
`summaries[]`	Object	The search result summary settings. See Summary.
`queryProcessors[]`	Object	The query analysis rules. See QueryProcessor.

Status values

The status field returns one of the following values:

Value	Description
`ok`	The version is running normally.
`stopped`	The version has been stopped.
`frozen`	The version is frozen and not accepting queries.
`initializing`	The version is being initialized.
`unavailable`	The version is not available.
`data_waiting`	The version is waiting for data to be ready.
`data_preparing`	The service is preparing data for the version.

Type values

The type field identifies the application type:

Value	Description
`standard`	A standard application.
`advance`	An advanced application of the legacy type. New applications cannot use this type.
`enhanced`	An advanced application of the current type.