Queries the rough sort expressions that are configured for 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]/first-ranks 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 110157886

The ID of the version.

Response parameters

Parameter Type Example Description
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

The ID of the request.

result Array of firstRankItem

The information about each rough sort expression.

For more information, see FirstRank.

active Boolean true

Indicates whether the expression is the default one.

created Integer 0
description String ""

The description of the expression.

meta Array of metaItem

The content of the expression.

arg String ""

The parameters that are used by a function in the expression.

For more information, see Rough sort functions.

attribute String static_bm25()

The attribute, feature function, or field to be searched for.

For more information about supported feature functions, see Rough sort functions.

weight Integer 1

The weight.

Valid values: [-100000,100000] (excluding 0).

name String default

The name of the expression.

updated Integer 0

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/apps/110157886/first-ranks

Sample success responses

XML format

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <name>default</name>
    <description/>
    <active>true</active>
    <type>STRUCT</type>
    <meta>
        <attribute>static_bm25()</attribute>
        <arg/>
        <weight>1</weight>
    </meta>
    <created>0</created>
    <updated>0</updated>
</result>

JSON format

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": {
        "name": "default",
        "description": "",
        "active": true,
        "type": "STRUCT",
        "meta": {
            "attribute": "static_bm25()",
            "arg": "",
            "weight": 1
        },
        "created": 0,
        "updated": 0
    }
}

Error codes

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