Renews an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

POST /v4/openapi/app-groups/[appGroupIdentity]/actions/renew HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app

The name of the application.

Optional parameters

Parameter

Type

Description

duration

Integer

The renewal period. Default value: 1.

pricingCycle

String

The unit of the renewal period. Valid values:

  • Year
  • Month

Response parameters

Parameter Type Example Description
requestId String D77D0DAF-790D-F5F5-A9C0-133738165014

Examples

Sample requests

POST /v4/openapi/app-groups/my_app/actions/renew

{
    "duration": 1,
    "pricingCycle": "Year"
}

Sample success responses

XML format

<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>
<result/>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.