帮你快速理解、总结文档立即下载
文档中心>腾讯云可观测平台

查询值班列表

最近更新时间：2026-08-27 02:32:24
我的收藏

本页目录：

1. 接口描述

接口请求域名： monitor.tencentcloudapi.com 。

查询值班列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeOnCallForms。
Version 是 String 公共参数，本接口取值：2018-07-24。
Region 否 String 公共参数，此参数为可选参数。
Module 是 String

固定值，为"monitor"


示例值：monitor
Offset 是 Integer

分页查询起始位


示例值：1
Limit 是 Integer

分页查询页数


示例值：10
OnCallFormStaffIDs.N 否 Array of String

支持userId进行检索


示例值：["317528"]
RotationType 否 String

值班类型


示例值：day
Order 否 String

排序方式


示例值：desc
OnCallFormName 否 String

支持id、name进行检索


示例值：值班分组

3. 输出参数

参数名称 类型 描述
OnCallForms Array of OnCallForm

排班信息
TotalCount Integer

总数


示例值：10
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询值班列表

查询值班列表

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOnCallForms
<公共请求参数>

{
    "Module": "monitor",
    "OnCallFormStaffIDs": [
        "317528"
    ],
    "RotationType": "day",
    "Offset": 1,
    "Limit": 10,
    "Order": "desc",
    "OnCallFormName": "值班分组"
}

输出示例

{
    "Response": {
        "OnCallForms": [
            {
                "OnCallFormID": "form-zahdhgjo",
                "OnCallFormName": "值班分组",
                "OnCallFormDesc": "值班分组",
                "RotationType": "day",
                "ShiftTime": "12:00",
                "EffectiveStartTime": 1648742400,
                "EffectiveEndTime": 1649520000,
                "TimeZone": 8,
                "CurrOnCallStaffs": [
                    "317528"
                ],
                "Tags": [
                    {
                        "Key": "petertest",
                        "Value": "petertest"
                    }
                ]
            }
        ],
        "TotalCount": 10,
        "RequestId": "e3873490-7ca2-4efc-8792-77"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

中国站