CreateWarehouseScheduleTask - Hologres - Alibaba Cloud Documentation Center

Operation description

Creates a time-based elastic scaling plan for a compute group of a specified Hologres instance. Before calling this operation, call ListWarehouses to obtain the compute group ID.

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

hologram:CreateWarehouseScheduleTask

create

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

POST /api/v1/instances/{instanceId}/createWarehouseScheduleTask HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The Hologres instance ID.	hgpostcn-cn-lbj33559x001

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters for creating a time-based elastic scaling plan.
warehouseId	integer	Yes	The compute group ID. You can call ListWarehouses to obtain this ID.	1
startTime	string	Yes	The start time. The value is in the HHmm format (four digits, 24-hour clock) and must be on the hour or half hour, such as 0030, 0100, or 0400.	0100
endTime	string	Yes	The end time. The value is in the HHmm format (four digits, 24-hour clock) and must be on the hour or half hour, such as 0030, 0100, or 0400. The end time must be later than the start time.	0200
elasticCu	integer	Yes	The number of elastic CPU cores. The value must be a multiple of 16, and must be greater than or equal to 16 and less than or equal to the specifications of the current compute group.	32
description	string	No	The description of the time-based elastic scaling plan.	user stat

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Data	string	The creation result. A value of true indicates success. A value of false indicates failure.	true

Examples

Success response

JSON format

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "Data": "true"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.