GetServiceGroupScheduling-阿里云帮助中心

Queries the scheduling details 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:GetServiceGroupScheduling

get

*All Resource

*

None

Request syntax

POST /services/group/scheduling/detail 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.	9999
clientToken	string	No	The idempotency token.	C4BE3837-1A13-413B-A225-2C88188E8A43

Response elements

Element	Type	Description	Example
	object	The response structure.
requestId	string	The request ID.	xxxxxxxxxxxx
data	object	The scheduling details.
schedulingWay	string	The scheduling method. Valid values: FAST: Fast scheduling. FINE: Fine scheduling.	FINE
serviceGroupId	integer	The ID of the service group.	99999
fastScheduling	object	The fast scheduling details.
singleDuration	integer	The shift duration per person.	12
dutyPlan	string	The duty plan. Valid values: FAST_CHOICE: Quick selection. CUSTOM: Custom.	FAST_CHOICE
singleDurationUnit	string	The unit of the shift duration per person. Valid values: HOUR: Hours. DAY: Days.	DAY
schedulingUsers	array<object>	The users for fast shift rotation.
	object	The fast scheduling user.
schedulingUserId	integer	The ID of the shift rotation user.	66666
schedulingOrder	integer	The scheduling order.	1
schedulingUserName	string	The name of the shift rotation user.	Mr. Zhang
schedulingUserIdList	array	The IDs of the users for multi-person scheduling.
	integer	The user ID.	66666
schedulingObjectType	string	The scheduling object type.	single
id	integer	The fast scheduling ID.	2222
fineScheduling	object	The fine scheduling details.
period	integer	The cycle period.	Cycle period
id	integer	The fine scheduling ID.	Fine scheduling ID
periodUnit	string	The unit of the cycle period. Valid values: HOUR: Hours. DAY: Days.	DAY
shiftType	string	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>	The personnel information for fine scheduling shifts.
	object	The fine scheduling details.
schedulingStartTime	string	The start time of the shift, in the YYYY-MM-DD format.	2020-08-13
schedulingEndTime	string	The end time of the shift, in the YYYY-MM-DD format.	2020-10-13
schedulingOrder	integer	The scheduling order.	1
shiftName	string	The name of the shift.	Morning shift
cycleOrder	integer	The cycle order.	1
schedulingUserId	integer	The ID of the scheduling user.	1111
skipOneDay	boolean	Indicates whether the shift spans across days.	false
schedulingUserName	string	The name of the scheduling user.	Liu Dehua
schedulingUserIdList	array	The IDs of the users for multi-person scheduling.
	integer	The user ID.	66666
schedulingObjectType	string	The task scheduling type.	single
schedulingTemplateFineShifts	array<object>	The fine scheduling template.
	object	The fine scheduling template.
schedulingStartTime	string	The start time of the shift, in the YYYY-MM-DD HH:mm:ss format.	2021-09-01 00:00:00
schedulingEndTime	string	The end time of the shift, in the YYYY-MM-DD HH:mm:ss format.	2021-10-01 00:00:00
schedulingOrder	integer	The scheduling order.	1
schedulingUserId	string	The user ID.	1
skipOneDay	boolean	Indicates whether the shift spans across days.	true
schedulingUserName	string	The name of the scheduling user.	Liu Dehua
shiftName	string	The name of the shift.	Morning shift
schedulingUserIdList	array	The IDs of the users for multi-person scheduling.
	integer	The user ID.	66666
schedulingObjectType	string	The task scheduling type.	single
users	array<object>	The scheduled users.
	object	The scheduled user.
userId	integer	The user ID.	66666
userName	string	The username.	Username

Examples

Success response

JSON format

{
  "requestId": "xxxxxxxxxxxx",
  "data": {
    "schedulingWay": "FINE",
    "serviceGroupId": 99999,
    "fastScheduling": {
      "singleDuration": 12,
      "dutyPlan": "FAST_CHOICE",
      "singleDurationUnit": "DAY",
      "schedulingUsers": [
        {
          "schedulingUserId": 66666,
          "schedulingOrder": 1,
          "schedulingUserName": "张先生",
          "schedulingUserIdList": [
            66666
          ],
          "schedulingObjectType": "single"
        }
      ],
      "id": 2222
    },
    "fineScheduling": {
      "period": 0,
      "id": 0,
      "periodUnit": "DAY",
      "shiftType": "MORNING_NIGHT",
      "schedulingFineShifts": [
        {
          "schedulingStartTime": "2020-08-13",
          "schedulingEndTime": "2020-10-13",
          "schedulingOrder": 1,
          "shiftName": "早班",
          "cycleOrder": 1,
          "schedulingUserId": 1111,
          "skipOneDay": false,
          "schedulingUserName": "刘德华",
          "schedulingUserIdList": [
            66666
          ],
          "schedulingObjectType": "single"
        }
      ],
      "schedulingTemplateFineShifts": [
        {
          "schedulingStartTime": "2021-09-01 00:00:00",
          "schedulingEndTime": "2021-10-01 00:00:00",
          "schedulingOrder": 1,
          "schedulingUserId": "1",
          "skipOneDay": true,
          "schedulingUserName": "刘德华",
          "shiftName": "早班",
          "schedulingUserIdList": [
            66666
          ],
          "schedulingObjectType": "single"
        }
      ]
    },
    "users": [
      {
        "userId": 66666,
        "userName": "用户名字"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	ResourceNotFound	The specified Resource is not found.	The specified Resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.