Queries the on-duty engineers in a shift schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListShiftPersonnels

The operation that you want to perform. Set the value to ListShiftPersonnels.

ShiftScheduleIdentifier String Yes 2ab6456ada634b2f938ee******9b45b

The unique identifier of the shift schedule.

UserType String No ALL

The type of on-duty engineers that you want to query. Valid values: ALL, PRIMARY, BACKUP, and DESIGNATED_USER.

ShiftPersonUID String No 1933790****551

The ID of your 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 obtain the ID.

BeginTime Long Yes 1593950832000

The time when the on-duty engineer starts a shift. Set the value to a UNIX timestamp.
EndTime Long Yes 1593950832000

The time when the on-duty engineer ends a shift. Set the value to a UNIX timestamp.

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EFG

The ID of the request. You can use the ID to troubleshoot issues.

Paging Object

The pagination data.
PageNumber Integer 1

The page number of the returned page. Minimum value: 1. Maximum value: 100. Default value: 1.

PageSize Integer 10

The number of entries returned per page. Default value: 10. Maximum value: 100.

TotalCount Integer 100

The total number of entries returned.

ShiftPersons Array of ShiftPersons

The on-duty engineers in the shift schedule.
ShiftPersonUID String 3726346****

The UID of the on-duty engineer.
ShiftPersonName String Bob

The name of the on-duty engineer.
BeginTime Long 1593950832000

The time when the on-duty engineer starts the shift.
EndTime Long 1593950832000

The time when the on-duty engineer ends the shift.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListShiftPersonnels
&ShiftScheduleIdentifier=2ab6456ada634b2f938ee******9b45b
&UserType=ALL
&ShiftPersonUID=1933790****551
&BeginTime=1593950832000
&EndTime=1593950832000
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListShiftPersonnelsResponse>
    <RequestId>0000-ABCD-EFG</RequestId>
    <Paging>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <ShiftPersons>
            <ShiftPersonUID>3726346****</ShiftPersonUID>
            <ShiftPersonName>Bob</ShiftPersonName>
            <StartLong>1593950832000</StartLong>
            <EndLong>1593950832000</EndLong>
        </ShiftPersons>
    </Paging>
</ListShiftPersonnelsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0000-ABCD-EFG",
  "Paging" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "ShiftPersons" : [ {
      "ShiftPersonUID" : "3726346****",
      "ShiftPersonName" : "Bob",
      "StartLong" : 1593950832000,
      "EndLong" : 1593950832000
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.