CreateElasticPlan - OpenSearch - Alibaba Cloud Documentation Center

Creates an elastic plan.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/elastic-plans HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	No	The application name, application ID, or instance ID.	my_app

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to perform a pre-creation validation. Valid values: true: Performs validation only. false: Does not perform validation.	true
body	object	No	The request body.
name	string	No	The plan name.	elastic_plan_name
description	string	No	The description.	my elastic plan
scheduleType	string	No	The task scheduling type.	WEEK
customDates	array	No	The list of days of the week.
	string	No	The list of days of the week.	MONDAY-SUNDAY
startHour	integer	No	The start time of the elastic plan.	0
endHour	integer	No	The end time of the elastic plan.	13
elasticLcu	integer	No	The elastic incremental LCU. The value must be greater than 0 and less than or equal to min(baseLcu × 0.5, 50000).	100

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	0FFF39C5-ED93-5234-806D-0824B967E6A3
httpCode	integer	The HTTP status code.	200
code	string	The error code.	ElasticPlan.NotFound
message	string	The error message.	Elastic plan not found
result	object	The returned result.
id	integer	The plan ID.	89047
name	string	The plan name.	name
description	string	The description.	desc
scheduleType	string	The task scheduling type.	WEEK
customDates	array	The list of days of the week.
	string	The list of days of the week.	"MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY"
startHour	integer	The start time of the plan.	9
endHour	integer	The end time of the plan.	15
elasticLcu	integer	The elastic LCU.	100
appGroupId	string	The application group ID.	100298370
enabled	boolean	Indicates whether the plan is enabled. Valid values: true: Enabled. false: Disabled.	True
created	integer	The creation time.	1588836130
updated	integer	The update time.	1588839490

Examples

Success response

JSON format

{
  "requestId": "0FFF39C5-ED93-5234-806D-0824B967E6A3",
  "httpCode": 200,
  "code": "ElasticPlan.NotFound",
  "message": "Elastic plan not found",
  "result": {
    "id": 89047,
    "name": "name",
    "description": "desc",
    "scheduleType": "WEEK",
    "customDates": [
      "\"MONDAY\", \"TUESDAY\", \"WEDNESDAY\", \"THURSDAY\", \"FRIDAY\""
    ],
    "startHour": 9,
    "endHour": 15,
    "elasticLcu": 100,
    "appGroupId": "100298370",
    "enabled": true,
    "created": 1588836130,
    "updated": 1588839490
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.