ListShiftPersonnels - DataWorks - Alibaba Cloud Documentation Center

Queries a list of on-duty engineers in a shift schedule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ShiftScheduleIdentifier	string	Yes	The unique identifier of the shift schedule.	2ab6456ada634b2f938ee******9b45b
UserType	string	No	The type of the on-duty engineer that you want to query. Valid values: ALL, PRIMARY, BACKUP, and DESIGNATED_USER.	ALL
ShiftPersonUID	string	No	The ID of the Alibaba Cloud account. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.	1933790****551
BeginTime	long	Yes	The time when the on-duty engineer starts a shift. Set the value to a UNIX timestamp.	1593950832000
EndTime	long	Yes	The time when the on-duty engineer ends a shift. Set the value to a UNIX timestamp.	1593950832000

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the ID to troubleshoot issues.	0000-ABCD-EFG
Paging	object	The pagination information.
PageNumber	integer	The page number. Valid values: 1 to 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 returned.	100
ShiftPersons	array<object>	The on-duty engineers in the shift schedule.
ShiftPersons	object	The on-duty engineer in the shift schedule.
ShiftPersonUID	string	The UID of the on-duty engineer.	3726346****
ShiftPersonName	string	The name of the on-duty engineer.	Zhang San
BeginTime	long	The time when the on-duty engineer starts the shift.	1593950832000
EndTime	long	The time when the on-duty engineer ends the shift.	1593950832000

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-06-07	Add Operation	View Change Details