Queries the details about a version of an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId] HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

appId Integer Path Yes 110116134

The ID of the version.

Response parameters

Parameter Type Example Description
requestId String 33477D76-C380-1D84-A4AD-043F52876CB1

The ID of the request.

result Struct

The information about the version.

algoDeploymentId Integer 0

The ID of the created rough sort expression.

autoSwitch Boolean true

Indicates whether the version is automatically published to the online environment.

clusterName String -
created Integer 1590977140

The timestamp when the version was created.

description String -

The description of the version.

fetchFields List {}

The default display fields.

id String 100303063

The ID of the version.

progressPercent Integer 100

The progress of data import, in percentage. For example, a value of 83 indicates 83%.

quota Struct

The quota information about the version.

computeResource Integer 20

The computing resources. Unit: logical computing units (LCUs).

docSize Integer 1

The storage capacity. Unit: GB.

qps Integer 5

The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.

spec String opensearch.share.common

The specifications of the application. Valid values:

  • opensearch.share.junior: basic
  • opensearch.share.common: shared general-purpose
  • opensearch.share.compute: shared computing
  • opensearch.share.storage: shared storage
  • opensearch.private.common: exclusive general-purpose
  • opensearch.private.compute: exclusive computing
  • opensearch.private.storage: exclusive storage
schema Map {}

The application schema.

status String ok

The status of the version. Valid values:

  • ok
  • stopped
  • frozen
  • initializing
  • unavailable
  • data_waiting
  • data_preparing
type String enhanced

The type of the application. Valid values:

  • standard: a standard application.
  • advance: an advanced application which is of an old application type. New applications cannot be of this type.
  • enhanced: an advanced application which is of a new application type.

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/apps/100303063

Sample success responses

XML format

<requestId>33477D76-C380-1D84-A4AD-043F52876CB1</requestId>
<result>
    <id>100303063</id>
    <description/>
    <status>ok</status>
    <fetchFields>id</fetchFields>
    <fetchFields>title</fetchFields>
    <fetchFields>buy</fetchFields>
    <fetchFields>cate_id</fetchFields>
    <fetchFields>cate_name</fetchFields>
    <type>enhanced</type>
    <schema>
        <tables>
            <main>
                <primaryTable>true</primaryTable>
                <name>main</name>
                <fields>
                    <id>
                        <name>id</name>
                        <type>LITERAL</type>
                        <primaryKey>true</primaryKey>
                    </id>
                    <title>
                        <name>title</name>
                        <type>TEXT</type>
                        <primaryKey>false</primaryKey>
                    </title>
                    <buy>
                        <name>buy</name>
                        <type>INT</type>
                        <primaryKey>false</primaryKey>
                    </buy>
                    <cate_id>
                        <name>cate_id</name>
                        <type>INT</type>
                        <primaryKey>false</primaryKey>
                    </cate_id>
                    <cate_name>
                        <name>cate_name</name>
                        <type>LITERAL</type>
                        <primaryKey>false</primaryKey>
                    </cate_name>
                </fields>
            </main>
        </tables>
        <indexes>
            <searchFields>
                <id>
                    <fields>id</fields>
                </id>
                <default>
                    <fields>title</fields>
                    <analyzer>chn_standard</analyzer>
                </default>
                <buy>
                    <fields>buy</fields>
                </buy>
            </searchFields>
            <filterFields>id</filterFields>
            <filterFields>buy</filterFields>
            <filterFields>cate_id</filterFields>
            <filterFields>cate_name</filterFields>
        </indexes>
    </schema>
    <algoDeploymentId>0</algoDeploymentId>
    <firstRanks>
        <id/>
        <name>default</name>
        <description/>
        <active>false</active>
        <type>STRUCT</type>
        <meta>
            <attribute>static_bm25()</attribute>
            <arg/>
            <weight>1</weight>
        </meta>
        <created>0</created>
        <updated>0</updated>
    </firstRanks>
    <firstRanks>
        <id>887857</id>
        <name>first_rank_lsh_1</name>
        <description/>
        <active>true</active>
        <type>STRUCT</type>
        <meta>
            <attribute>static_bm25()</attribute>
            <arg/>
            <weight>10</weight>
        </meta>
        <meta>
            <attribute>exact_match_boost()</attribute>
            <arg/>
            <weight>20</weight>
        </meta>
        <meta>
            <attribute>buy</attribute>
            <arg/>
            <weight>30</weight>
        </meta>
        <created>1590977140</created>
        <updated>1590977140</updated>
    </firstRanks>
    <secondRanks>
        <id>-1</id>
        <name>default</name>
        <meta/>
        <active>true</active>
        <description/>
        <created>0</created>
        <updated>0</updated>
    </secondRanks>
    <summaries>
        <name>default</name>
        <meta>
            <field>title</field>
            <len>50</len>
            <element>em</element>
            <ellipsis>...</ellipsis>
            <snippet>1</snippet>
        </meta>
    </summaries>
    <created>1590977140</created>
    <queryProcessors>
        <name>sum_lsh_test_1</name>
        <active>true</active>
        <indexes>default</indexes>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary/>
            <name>stop_word</name>
        </processors>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary/>
            <name>spell_check</name>
        </processors>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary/>
            <name>term_weighting</name>
        </processors>
        <processors>
            <useSystemDictionary>true</useSystemDictionary>
            <interventionDictionary/>
            <name>synonym</name>
        </processors>
        <domain>GENERAL</domain>
        <created>1590977142</created>
        <updated>1590977142</updated>
    </queryProcessors>
    <progressPercent>100</progressPercent>
</result>

JSON format

{
    "requestId": "33477D76-C380-1D84-A4AD-043F52876CB1",
    "result": {
        "id": 100303063,
        "description": "",
        "status": "ok",
        "fetchFields": [
            "id",
            "title",
            "buy",
            "cate_id",
            "cate_name"
        ],
        "type": "enhanced",
        "schema": {
            "tables": {
                "main": {
                    "primaryTable": true,
                    "name": "main",
                    "fields": {
                        "id": {
                            "name": "id",
                            "type": "LITERAL",
                            "primaryKey": true
                        },
                        "title": {
                            "name": "title",
                            "type": "TEXT",
                            "primaryKey": false
                        },
                        "buy": {
                            "name": "buy",
                            "type": "INT",
                            "primaryKey": false
                        },
                        "cate_id": {
                            "name": "cate_id",
                            "type": "INT",
                            "primaryKey": false
                        },
                        "cate_name": {
                            "name": "cate_name",
                            "type": "LITERAL",
                            "primaryKey": false
                        }
                    }
                }
            },
            "indexes": {
                "searchFields": {
                    "id": {
                        "fields": "id"
                    },
                    "default": {
                        "fields": "title",
                        "analyzer": "chn_standard"
                    },
                    "buy": {
                        "fields": "buy"
                    }
                },
                "filterFields": [
                    "id",
                    "buy",
                    "cate_id",
                    "cate_name"
                ]
            }
        },
        "algoDeploymentId": 0,
        "firstRanks": [
            {
                "id": "",
                "name": "default",
                "description": "",
                "active": false,
                "type": "STRUCT",
                "meta": {
                    "attribute": "static_bm25()",
                    "arg": "",
                    "weight": 1
                },
                "created": 0,
                "updated": 0
            },
            {
                "id": 887857,
                "name": "first_rank_lsh_1",
                "description": "",
                "active": true,
                "type": "STRUCT",
                "meta": [
                    {
                        "attribute": "static_bm25()",
                        "arg": "",
                        "weight": 10
                    },
                    {
                        "attribute": "exact_match_boost()",
                        "arg": "",
                        "weight": 20
                    },
                    {
                        "attribute": "buy",
                        "arg": "",
                        "weight": 30
                    }
                ],
                "created": 1590977140,
                "updated": 1590977140
            }
        ],
        "secondRanks": {
            "id": -1,
            "name": "default",
            "meta": "",
            "active": true,
            "description": "",
            "created": 0,
            "updated": 0
        },
        "summaries": {
            "name": "default",
            "meta": {
                "field": "title",
                "len": 50,
                "element": "em",
                "ellipsis": "...",
                "snippet": 1
            }
        },
        "created": 1590977140,
        "queryProcessors": {
            "name": "sum_lsh_test_1",
            "active": true,
            "indexes": "default",
            "processors": [
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "",
                    "name": "stop_word"
                },
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "",
                    "name": "spell_check"
                },
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "",
                    "name": "term_weighting"
                },
                {
                    "useSystemDictionary": true,
                    "interventionDictionary": "",
                    "name": "synonym"
                }
            ],
            "domain": "GENERAL",
            "created": 1590977142,
            "updated": 1590977142
        },
        "progressPercent": 100
    }
}

Error codes

For a list of error codes, visit the API Error Center.