ListShiftPersonnels-DataWorks(DataWorks)-阿里云帮助中心

Retrieves the list of on-duty personnel for a shift schedule.

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 parameters

Parameter	Type	Required	Description	Example
ShiftScheduleIdentifier	string	Yes	The unique identifier of the shift schedule.	2ab6456ada634b2f938ee******9b45b
UserType	string	No	The query condition for on-duty personnel. Valid values: ALL: all on-duty personnel. PRIMARY: primary on-duty personnel. BACKUP: backup on-duty personnel. DESIGNATED_USER: designated personnel. Valid values: ALL : All on-duty personnel. BACKUP : Backup on-duty personnel. DESIGNATED_USER : Designated personnel. PRIMARY : Primary on-duty personnel.	ALL
ShiftPersonUID	string	No	The Alibaba Cloud account ID. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the account ID.	1933790****551
BeginTime	integer	Yes	The start time of the on-duty period. This value is a timestamp.	1593950832000
EndTime	integer	Yes	The end time of the on-duty period. This value is a timestamp.	1593950832000

Response elements

Element	Type	Description	Example
	object	The API response.
RequestId	string	The request ID. You can use this ID to troubleshoot issues.	0000-ABCD-EFG
Paging	object	The pagination result.
PageNumber	integer	The page number. Minimum value: 1. Maximum value: 100. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of entries that meet the conditions.	100
ShiftPersons	array<object>	The list of on-duty personnel.
	object	The on-duty person.
ShiftPersonUID	string	The UID of the on-duty person.	3726346****
ShiftPersonName	string	The name of the on-duty person.	Zhang San
BeginTime	integer	The start time of the on-duty cycle. The value is a 13-digit timestamp, for example, `1593950832000`.	1593950832000
EndTime	integer	The end time of the on-duty cycle. The value is a 13-digit timestamp, for example, `1593950832000`.	1593950832000

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EFG",
  "Paging": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "ShiftPersons": [
      {
        "ShiftPersonUID": "3726346****",
        "ShiftPersonName": "Zhang San",
        "BeginTime": 1593950832000,
        "EndTime": 1593950832000
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.