All Products
Search
Document Center

OpenSearch:DescribeQueryProcessor

Last Updated:Oct 16, 2024

Queries the query analysis rule for a version of an OpenSearch application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:DescribeQueryProcessor
  • QueryProcessor
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors/{name} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

my_app_group_name

my_app_group_name
appIdintegerYes

110157886

110157886
namestringYes

test

test

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultobject

The information about the query analysis rule.

createdinteger

The time when the query analysis rule was created.

1587398402
activeboolean

Indicates whether the query analysis rule is the default one.

true
updatedinteger

The time when the query analysis rule was last updated.

1587398402
namestring

The name of the query analysis rule.

test
domainstring

The type of the industry. Valid values:

  • GENERAL
  • ECOMMERCE
  • IT_CONTENT
GENERAL
indexesarray

The indexes to which the query analysis rule applies.

indexesstring
default
processorsarray

The features that are used in the query analysis rule.

processorsstring
{}

Examples

Sample success responses

JSONformat

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1587398402,
    "active": true,
    "updated": 1587398402,
    "name": "test",
    "domain": "GENERAL",
    "indexes": [
      "default"
    ],
    "processors": [
      "{}"
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history