GetOnCallSchedulesDetail - 查询排班策略信息

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:GetOnCallSchedulesDetailnone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Idlong

排班策略 ID。

1234
StartTimestring

开始值班时间,格式为yyyy-MM-dd

2022-10-01
EndTimestring

结束值班时间,格式为yyyy-MM-dd

2022-10-30

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

21E85B16-75A6-429A-9F65-8AAC9A54****
Dataobject

排班策略详细信息。

Idlong

排班策略 ID。

1234
Namestring

排名策略名称。

排班策略测试
Descriptionstring

排班策略描述信息。

测试
AlertRobotIdlong

换班通知的钉钉机器人地址。

https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******
ScheduleLayersarray<object>

值班班次。

scheduleLayersobject
ContactIdsarray

排班人员 ID 列表。

contactIdslong

排班人员 ID。

[123, 234, 456]
StartTimestring

换班生效起始时间。

2022-10-01
ShiftLengthlong

换班周期,单位为小时。

8
RotationTypestring

换班类型:

  • DAY: 天
  • WEEK: 周
  • CUSTOM: 自定义
DAY
Restrictionsarray<object>

排班限制时间。

restrictionsobject
RestrictionTypestring

限制时间类型:

  • daily_restriction:天
  • weekly_restriction:周
daily_restriction
StartTimeOfDaystring

每天开始值班时间。

09:00
EndTimeOfDaystring

每天结束值班时间。

18:00
RenderedLayerEntriesarray

查询时间范围内的排班人员。

renderedLayerEntriesarray<object>
renderedLayerEntriesobject
Startstring

排班人开始值班时间。

2022-10-01
Endstring

排班人结束值班时间。

2022-10-30
SimpleContactobject

排班人信息。

Idlong

排班人 ID。

123
Namestring

排班人名称。

员工1
RenderedSubstitudeEntriesarray<object>

查询时间范围内的替班人员。

renderedSubstitudeEntriesobject
Startstring

替班人开始值班时间。

2022-10-01
Endstring

替班人结束值班时间。

2022-10-30
SimpleContactobject

替班人信息。

Idlong

替班人 ID。

234
Namestring

替班人名称。

员工2
RenderedFinnalEntriesarray<object>

最终值班人员信息。

renderedFinnalEntriesobject
Startstring

值班人开始值班时间。

2022-10-01
Endstring

值班人结束值班时间。

2022-10-30
SimpleContactobject

值班人信息。

Idlong

值班人 ID。

123
Namestring

值班人名称。

员工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查看变更详情