GetServiceGroupSchedulingPreview-阿里云帮助中心

Previews the schedule of a service group.

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

gemp:GetServiceGroupSchedulingPreview

get

*All Resource

*

None

Request syntax

POST /services/group/scheduling/preview HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
serviceGroupId	integer	Yes	The ID of the service group.	55555
schedulingWay	string	Yes	The scheduling method. Valid values: FAST: quick scheduling FINE: fine-grained scheduling	FAST
fastScheduling	object	No	The quick scheduling settings.
singleDuration	integer	No	The shift duration per user.	12
dutyPlan	string	No	The duty plan. Valid values: FAST_CHOICE: quick selection CUSTOM: custom	FAST_CHOICE
singleDurationUnit	string	No	The unit of the shift duration. Valid values: HOUR: hours DAY: days	DAY
schedulingUsers	array<object>	No	The users for quick shifts.
	object	No	The users for quick shifts.
schedulingUserId	integer	No	The ID of the shift user.	122222
schedulingOrder	integer	No	The scheduling order.	1
fineScheduling	object	No	The fine-grained scheduling settings.
period	integer	No	The cycle period.	2
periodUnit	string	No	The unit of the cycle period. Valid values: HOUR: hours DAY: days	DAY
shiftType	string	No	The shift type. Valid values: MORNING_NIGHT: morning and night shifts MORNING_NOON_NIGHT: morning, noon, and night shifts CUSTOM: custom	MORNING_NIGHT
schedulingFineShifts	array<object>	No	The personnel information for fine-grained shifts.
	object	No	The personnel information for fine-grained shifts.
schedulingStartTime	string	No	The start time of the shift. The format is YYYY-MM-DD.	2020-08-13
schedulingEndTime	string	No	The end time of the shift. The format is YYYY-MM-DD.	2020-10-13
schedulingOrder	integer	No	The scheduling order.	1
shiftName	string	No	The name of the shift.	Morning shift
clientToken	string	No	The idempotency token.	C4BE3837-1A13-413B-A225-2C88188E8A43
endTime	string	No	The end time for the schedule preview. The format is YYYY-MM-DD HH:mm:ss.	2021-09-01 00:00:00
startTime	string	No	The start time for the schedule preview. The format is YYYY-MM-DD HH:mm:ss.	2021-11-01 00:00:00

Response elements

Element	Type	Description	Example
	object	The response struct.
requestId	string	The ID of the request.	85C203BF-D1A6-562C-AAEC-5EAB9D2756CF
data	object	The schedule dates of the service group.	{"2021-09-09":[{"schedulingDate":"2021-09-09","schedulingStartTime":"2021-09-09 09:00:00","schedulingEndTime":"2021-09-09 18:00:00","schedulingUserId":123456,"schedulingUserName":"On-call staff","schedulingOrder":1,"skipOneDay":false}]}

Examples

Success response

JSON format

{
  "requestId": "85C203BF-D1A6-562C-AAEC-5EAB9D2756CF",
  "data": {
    "2021-09-09": [
      {
        "schedulingDate": "2021-09-09",
        "schedulingStartTime": "2021-09-09 09:00:00",
        "schedulingEndTime": "2021-09-09 18:00:00",
        "schedulingUserId": 123456,
        "schedulingUserName": "值班员",
        "schedulingOrder": 1,
        "skipOneDay": false
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is not valid. %s	The specified parameter is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.