ListWarehouseScheduleTask - Hologres - Alibaba Cloud Documentation Center

Retrieves the list of all time-based elastic scaling plan tasks for compute groups under a specified instance.

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:ListWarehouseScheduleTask

list

*Instance

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

None

Request syntax

GET /api/v1/instances/{instanceId}/listWarehouseScheduleTask HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	hgpost-cn-xxxx

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8
ScheduleTaskList	array<object>	The list of time-based elastic scaling plans.
	array<object>
WarehouseId	string	The compute group ID.	1
WarehouseName	string	The compute group name.	init_warehouse
Plans	array<object>	The list of elastic scaling plans for a single compute group.
	object
StartTime	string	The start time. Only on-the-hour and half-hour values are supported, such as 0100 for 1:00 AM. The format is HHmm (four digits, 24-hour clock).	0100
EndTime	string	The end time. Only on-the-hour and half-hour values are supported. The format is HHmm (four digits, 24-hour clock).	0400
ElasticCu	integer	The elastic resource value. The value must be a multiple of 16, greater than or equal to 16, and less than or equal to the compute group specifications.	32
Description	string	The description of the elastic scaling plan.	bill stat
Id	string	The elastic scaling plan ID.	1802985780260052993
ReservedCpu	integer	The reserved resources of the compute group.	32
Status	string	The compute group status. Valid values: kRunning: Running. kSuspended: Suspended. kAllocating: Processing. Valid values: kRunning : Running. kSuspended : Suspended. kAllocating : Processing.	kRunning
ElasticType	string	The elastic scaling type.	timed

Examples

Success response

JSON format

{
  "RequestId": "A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8",
  "ScheduleTaskList": [
    {
      "WarehouseId": "1",
      "WarehouseName": "init_warehouse",
      "Plans": [
        {
          "StartTime": "0100",
          "EndTime": "0400",
          "ElasticCu": 32,
          "Description": "bill stat",
          "Id": "1802985780260052993"
        }
      ],
      "ReservedCpu": 32,
      "Status": "kRunning",
      "ElasticType": "timed"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.