Switch OpenSearch Apps to Instance-Based Using ReplaceAppGroupCommodityCode - OpenSearch - Alibaba Cloud - OpenSearch

Converts a service-based application to an instance-based application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:UpdateApp

none

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:apps/{#appGroupIdentity}

None

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/actions/to-instance-typed HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application	my_app

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	AC5F78BA-66B9-545B-9CF1-8F542E682E1F
result	object	The returned result.	{}
created	integer	The timestamp when the application was created.	1588054131
currentVersion	string	The ID of the current online version.	100302903
pendingSecondRankAlgoDeploymentId	integer	The ID of the fine sort expression that is being created.	0
type	string	The type of the application.	-
chargingWay	integer	The billing type. Valid values: 1: computing resources. 2: queries per second (QPS).	1
lockMode	string	The lock state. Valid values: Unlock: The instance is unlocked. LockByExpiration: The instance is automatically locked after it expires. ManualLock: The instance is manually locked.	Unlock
status	string	The status of the application.	normal
updated	integer	The timestamp when the application was updated.	1581065904
chargeType	string	The billing method. Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription.	POSTPAY
id	string	The application ID.	-
hasPendingQuotaReviewTask	integer	The approval state of the quotas. Valid values: 0: The approval status is normal. 1: The quotas are being approved.	0
projectId	string	The name of the A/B test group.	-
secondRankAlgoDeploymentId	integer	The ID of the fine sort expression.	0
commodityCode	string	The code of the commodity.	opensearch
switchedTime	integer	The timestamp when the current online version was published.	1590486386
expireOn	string	The expiration time.	-
description	string	The description of the application.	""
firstRankAlgoDeploymentId	integer	The ID of the rough sort expression.	0
lockedByExpiration	integer	Indicates whether the instance is automatically locked after it expires. Valid values: 0: The instance is not automatically locked after it expires. 1: The instance is automatically locked after it expires.	0
produced	integer	Indicates whether the order is produced.	0
name	string	The name of the order.	-
processingOrderId	string	The ID of the order that is in progress.	-
instanceId	string	The instance ID.	-
versions	array	The versions.
	string	The version.	-
quota	object	The configuration information.
spec	string	The specifications configured.	-
docSize	integer	The storage capacity.	1
computeResource	integer	The number of computing resources configured.	20

Examples

Success response

JSON format

{
  "requestId": "AC5F78BA-66B9-545B-9CF1-8F542E682E1F",
  "result": {
    "created": 1588054131,
    "currentVersion": "100302903",
    "pendingSecondRankAlgoDeploymentId": 0,
    "type": "-",
    "chargingWay": 1,
    "lockMode": "Unlock",
    "status": "normal",
    "updated": 1581065904,
    "chargeType": "POSTPAY",
    "id": "-",
    "hasPendingQuotaReviewTask": 0,
    "projectId": "-",
    "secondRankAlgoDeploymentId": 0,
    "commodityCode": "opensearch",
    "switchedTime": 1590486386,
    "expireOn": "-",
    "description": "\"\"",
    "firstRankAlgoDeploymentId": 0,
    "lockedByExpiration": 0,
    "produced": 0,
    "name": "-",
    "processingOrderId": "-",
    "instanceId": "-",
    "versions": [
      "-"
    ],
    "quota": {
      "spec": "-",
      "docSize": 1,
      "computeResource": 20
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.