ListWarehouseScheduleTask - Hologres - Alibaba Cloud Documentation Center

Lists all warehouse schedule tasks for 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

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

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	The response object.
RequestId	string	The request ID.	A0A16C46-5B56-1F9B-AA37-4C3EAD95AAA8
ScheduleTaskList	array<object>	The list of warehouse schedule tasks.
	array<object>
WarehouseId	string	The ID of the warehouse.	1
WarehouseName	string	The name of the warehouse.	init_warehouse
Plans	array<object>	The scaling plans for the warehouse.
	object
StartTime	string	The start time of the plan. The time must be on the hour or half-hour and in the HHmm format. For example, 0100 represents 01:00.	0100
EndTime	string	The end time of the plan. The time must be on the hour or half-hour and in the HHmm format.	0400
ElasticCu	integer	The number of elastic resources. The value must be a multiple of 16, with a minimum value of 16, and cannot exceed the warehouse specification.	32
Description	string	The description of the scaling plan.	bill stat
Id	string	The ID of the scaling plan.	1802985780260052993
ReservedCpu	integer	The number of reserved resources for the warehouse.	32
Status	string	The status of the warehouse. Valid values: kRunning : The warehouse is running. kSuspended : The warehouse is suspended. kAllocating : The warehouse resources are being allocated.	kRunning
ElasticType	string	The 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.