All Products
Search
Document Center

:DescribeApp - Queries details about an application version.

Last Updated:Oct 25, 2022

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.

Debugging

Authorization information

No authorization information is revealed for the operation.

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

my_app_group_name
appIdintegerYes

The ID of the version.

110116134

Response parameters

ParameterTypeDescriptionExample
object

The response body.

{}
requestIdstring

The ID of the request.

33477D76-C380-1D84-A4AD-043F52876CB1
resultobject

The version information.

{}
createdinteger

The timestamp when the version was created.

1590977140
clusterNamestring

The name of the cluster.

-
autoSwitchboolean

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

true
algoDeploymentIdinteger

The ID of the created rough sort expression.

0
typestring

The type of the edition.

  • standard: a standard edition.
  • advance: an advanced edition which is of an old version. New version is not supported for this edition.
  • enhanced: an advanced edition which is of a new version.
enhanced
descriptionstring

The description of the version.

-
statusstring

The status of the version. Valid values:

  • ok: The version is normal.
  • stopped: The version is suspended.
  • frozen: The version is frozen.
  • initializing: The version is being initialized.
  • unavailable: The version is invalid.
  • data_waiting: Data is to be initialized.
  • data_preparing: Data is being initialized.
ok
schemaobject

The structure of the application.

{}
progressPercentinteger

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

100
idstring

The ID of the version.

100303063
fetchFieldsarray

The default display fields.

[]
string

The default display fields.

{}
quotaobject

The quota information about the version.

{}
specstring

The specifications.

  • 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
opensearch.share.common
qpsinteger

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

5
docSizeinteger

The storage capacity. Unit: GB.

1
computeResourceinteger

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

20
domainobject

The type of the industry. Valid values:

  • GENERAL
  • ECOMMERCE
  • IT_CONTENT
GENERAL
categorystring

The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.

-
namestring

The name (in English).

test
functionsobject

The search results.

{}
servicearray

The description about each feature.

[]
string

Feature 1.

-
qparray

The information about the layout.

[]
string

Information 1.

-
algoarray

The structure of the algorithm.

[]
string

Structure 1.

-

Examples

Sample requests

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

Sample success responses

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
    }
}

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>

Error codes

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