All Products
Search
Document Center

OpenSearch:DescribeApp

Last Updated:Mar 03, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeApp
  • App
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}
    none
none

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

my_app_group_name
appIdintegerYes

The ID of the version.

110116134

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

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

The information about the version.

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 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.
enhanced
descriptionstring

The description of the version.

-
statusstring

The status of the version. Valid values:

  • ok
  • stopped
  • frozen
  • initializing
  • unavailable
  • data_waiting
  • data_preparing
ok
schemaobject

The application schema.

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

The quota information about the version.

specstring

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

The category. By default, this parameter is left empty.

-
namestring

The name

test
functionsobject

search functions

servicearray

Function description

string

Function1

-
qparray

Queryprocessor description

string

Queryprocessor1

-
algoarray

Algorithm structure

string

algorithm1

-

Examples

Sample success responses

JSONformat

{
  "requestId": "33477D76-C380-1D84-A4AD-043F52876CB1",
  "result": {
    "created": 1590977140,
    "clusterName": "-",
    "autoSwitch": true,
    "algoDeploymentId": 0,
    "type": "enhanced",
    "description": "-",
    "status": "ok",
    "schema": {},
    "progressPercent": 100,
    "id": "100303063",
    "fetchFields": [
      "{}"
    ],
    "quota": {
      "spec": "opensearch.share.common",
      "qps": 5,
      "docSize": 1,
      "computeResource": 20
    },
    "domain": {
      "category": "-",
      "name": "test",
      "functions": {
        "service": [
          "-"
        ],
        "qp": [
          "-"
        ],
        "algo": [
          "-"
        ]
      }
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history