GetOnCallSchedulesDetail - 查询排班策略信息_应用实时监控服务(ARMS)-阿里云帮助中心

调用GetOnCallSchedulesDetail接口查询排班策略信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Id	long	是	排班策略 ID。	1234
StartTime	string	否	开始值班时间，格式为`yyyy-MM-dd`。	2022-10-01
EndTime	string	否	结束值班时间，格式为`yyyy-MM-dd`。	2022-10-30

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	21E85B16-75A6-429A-9F65-8AAC9A54****
Data	object	排班策略详细信息。
Id	long	排班策略 ID。	1234
Name	string	排名策略名称。	排班策略测试
Description	string	排班策略描述信息。	测试
AlertRobotId	long	换班通知的钉钉机器人地址。	https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******
ScheduleLayers	object []	值班班次。
ContactIds	array	排班人员 ID 列表。
	long	排班人员 ID。	[123, 234, 456]
StartTime	string	换班生效起始时间。	2022-10-01
ShiftLength	long	换班周期，单位为小时。	8
RotationType	string	换班类型： DAY：天 WEEK：周 CUSTOM：自定义	DAY
Restrictions	object []	排班限制时间。
RestrictionType	string	限制时间类型： daily_restriction：天 weekly_restriction：周	daily_restriction
StartTimeOfDay	string	每天开始值班时间。	09:00
EndTimeOfDay	string	每天结束值班时间。	18:00
RenderedLayerEntries	array	查询时间范围内的排班人员。
	object []
Start	string	排班人开始值班时间。	2022-10-01
End	string	排班人结束值班时间。	2022-10-30
SimpleContact	object	排班人信息。
Id	long	排班人 ID。	123
Name	string	排班人名称。	员工1
RenderedSubstitudeEntries	object []	查询时间范围内的替班人员。
Start	string	替班人开始值班时间。	2022-10-01
End	string	替班人结束值班时间。	2022-10-30
SimpleContact	object	替班人信息。
Id	long	替班人 ID。	234
Name	string	替班人名称。	员工2
RenderedFinnalEntries	object []	最终值班人员信息。
Start	string	值班人开始值班时间。	2022-10-01
End	string	值班人结束值班时间。	2022-10-30
SimpleContact	object	值班人信息。
Id	long	值班人 ID。	123
Name	string	值班人名称。	员工1

示例

正常返回示例

JSON格式

{
  "RequestId": "21E85B16-75A6-429A-9F65-8AAC9A54****",
  "Data": {
    "Id": 1234,
    "Name": "排班策略测试",
    "Description": "测试",
    "AlertRobotId": 0,
    "ScheduleLayers": [
      {
        "ContactIds": [
          0
        ],
        "StartTime": "2022-10-01\n",
        "ShiftLength": 8,
        "RotationType": "DAY",
        "Restrictions": [
          {
            "RestrictionType": "daily_restriction",
            "StartTimeOfDay": "09:00",
            "EndTimeOfDay": "18:00"
          }
        ]
      }
    ],
    "RenderedLayerEntries": [
      [
        {
          "Start": "2022-10-01",
          "End": "2022-10-30",
          "SimpleContact": {
            "Id": 123,
            "Name": "员工1"
          }
        }
      ]
    ],
    "RenderedSubstitudeEntries": [
      {
        "Start": "2022-10-01",
        "End": "2022-10-30",
        "SimpleContact": {
          "Id": 234,
          "Name": "员工2"
        }
      }
    ],
    "RenderedFinnalEntries": [
      {
        "Start": "2022-10-01",
        "End": "2022-10-30",
        "SimpleContact": {
          "Id": 123,
          "Name": "员工1"
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-07-26	新增 OpenAPI	看变更集