DescribeApp - OpenSearch - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:DescribeApp	get	App acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
appId	integer	Yes	The ID of the version.	110116134

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The ID of the request.	33477D76-C380-1D84-A4AD-043F52876CB1
result	object	The information about the version.
created	integer	The timestamp when the version was created.	1590977140
clusterName	string	The name of the cluster.	-
autoSwitch	boolean	Indicates whether the version is automatically published to the online environment.	true
algoDeploymentId	integer	The ID of the created rough sort expression.	0
type	string	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
description	string	The description of the version.	-
status	string	The status of the version. Valid values: ok stopped frozen initializing unavailable data_waiting data_preparing	ok
schema	object	The application schema.	{}
progressPercent	integer	The progress of data import, in percentage. For example, a value of 83 indicates 83%.	100
id	string	The ID of the version.	100303063
fetchFields	array	The default display fields.
fetchFields	string		{}
quota	object	The quota information about the version.
spec	string	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
qps	integer	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
docSize	integer	The storage capacity. Unit: GB.	1
computeResource	integer	The computing resources. Unit: logical computing units (LCUs).	20
domain	object	The type of the industry. Valid values: GENERAL ECOMMERCE IT_CONTENT
category	string	The category. By default, this parameter is left empty.	-
name	string	The name	test
functions	object	search functions
service	array	Function description
service	string	Function1	-
qp	array	Queryprocessor description
qp	string	Queryprocessor1	-
algo	array	Algorithm structure
algo	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 time	Summary of changes	Operation
2024-08-26	The response structure of the API has changed	View Change Details