Queries a rough sort expression that is 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/[name] 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.

name String Path Yes test

The name of the rough sort expression.

Response parameters

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

The ID of the request.

result Struct

The information about the rough sort expression.

active Boolean false

Indicates whether the expression is the default one.

description String -

The description of the expression.

meta Array of metaItem

The content of the expression.

arg String ar_edit_time

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

attribute String timeliness_ms()

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

weight Float 1

The weight.

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

name String ar_wear_edit_time

The name of the expression.

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/apps/150024378/first-ranks/ar_wear_edit_time

Sample success responses

XML format

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <name>ar_wear_edit_time</name>
    <type>STRUCT</type>
    <meta>
        <attribute>timeliness_ms()</attribute>
        <arg>ar_edit_time</arg>
        <weight>1</weight>
    </meta>
    <description/>
    <active>false</active>
    <created>0</created>
    <updated>0</updated>
</result>

JSON format

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

Error codes

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