DescribeElasticPlan - OpenSearch - Alibaba Cloud Documentation Center

Retrieves the details of an elastic plan.

Operation description

If a Standard Edition application with the same name already exists, a new version is created.
When creating a new version, autoSwitch and realtimeShared are also required.
When creating a new version, quota is automatically inherited from the previous version.
When creating a new version, modifying quota has no effect.

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

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	No	The name or ID of the application.	my_app_group_name
planId	integer	No	The ID of the alert plan.	3200000011

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to only validate the request parameters. Default value: false. Valid values: true: Only validates the parameters. false: Validates the parameters and creates the attribution configuration.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	0A6EB64B-B4C8-CF02-810F-E660812972FF
httpCode	integer	The HTTP status code. 1xx: Informational - The request has been received and is being processed. 2xx: Success - The request has been successfully received, understood, and accepted by the server. 3xx: Redirection - The request is redirected, and further action is required to complete the request. 4xx: Client error - The request contains invalid parameters, syntax errors, or specific request conditions cannot be met. 5xx: Server error - The server cannot fulfill the request due to other reasons.	200
code	string	The status code.	ElasticPlan.NotFound
message	string	args	Elastic plan not found
result	object	The returned result.
id	integer	The plan ID.	11
appGroupId	integer	The application ID.	120123456
name	string	The plan name.	plan name
description	string	The description.	desc
scheduleType	string	The scheduling type.	WEEK
customDates	array	The list of days of the week.
	string	The list of days of the week.	MONDAY-SUNDAY
startHour	integer	The start time of the elastic plan.	9
endHour	integer	The end time of the elastic plan.	13
elasticLcu	integer	The elastic incremental LCU.	100
enabled	boolean	Indicates whether the plan is enabled.	false
created	integer	The creation time.	1590139542
updated	integer	The update time.	1581065904

Examples

Success response

JSON format

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "httpCode": 200,
  "code": "ElasticPlan.NotFound",
  "message": "Elastic plan not found",
  "result": {
    "id": 11,
    "appGroupId": 120123456,
    "name": "plan name",
    "description": "desc",
    "scheduleType": "WEEK",
    "customDates": [
      "MONDAY-SUNDAY"
    ],
    "startHour": 9,
    "endHour": 13,
    "elasticLcu": 100,
    "enabled": false,
    "created": 1590139542,
    "updated": 1581065904
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.