RenewAppGroup - OpenSearch - Alibaba Cloud Documentation Center

Renews an application. This operation is not available now. You must renew an application in the OpenSearch console.

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:UpdateApp		AppGroup acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/actions/renew HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app
clientToken	string	No	The client token that is used to ensure the idempotence of the request.	74db41d8cd3c784209093aa76afbe89e
body	PrepayOrderInfo	No	The renewal request body.

Optional parameters

Parameter	Type	Description
duration	Integer	The renewal duration. Default value: 1.Valid values:- [1,2]. Unit: year.- [1,9]. Unit: month.
pricingCycle	String	The unit of the renewal duration.Valid values:- Year- Month
autoRenew	boolean	Specifies whether to enable auto-renewal. Default value: false.Valid values:- false- true

Response parameters

Parameter	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	boolean	Indicates whether the application was renewed.	true

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details