tencent cloud

APIs

DokumentasiAPIsTencent Cloud Observability PlatformAlarm APIsUpdateOnCallForm

UpdateOnCallForm

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-06-15 17:14:24

1. API Description

Domain name for API request: monitor.intl.tencentcloudapi.com.

Modifies an on-call schedule.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: UpdateOnCallForm.
Version Yes String Common Params. The value used for this API: 2018-07-24.
Region No String Common Params. This parameter is not required.
Module Yes String The fixed value is monitor.
OnCallFormID Yes String On-call schedule ID.
OnCallFormName Yes String On-call schedule name.
StaffInfos.N Yes Array of StaffInfo On-call personnel ID group.
RotationType Yes String Rotation type.
ShiftTime Yes String Shift change time.
EffectiveStartTime Yes Integer Effect time. Unit: seconds.
EffectiveEndTime Yes Integer End time of the validity period (in seconds).
TimeZone Yes Float Time zone (-12 to 12).
OnCallFormDesc No String Description of the shift schedule.
CoverStaffInfos.N No Array of CoverStaffInfo Shift information.

3. Output Parameters

Parameter Name Type Description
OnCallFormID String On-call schedule ID.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modify an On-Call Schedule

This example shows you how to modify an on-call schedule.

Input Example

POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateOnCallForm
<Common request parameters>

{
    "Module": "abc",
    "OnCallFormID": "abc",
    "OnCallFormName": "abc",
    "OnCallFormDesc": "abc",
    "StaffInfos": [
        {
            "StaffIDs": [
                "abc"
            ]
        }
    ],
    "RotationType": "abc",
    "ShiftTime": "abc",
    "EffectiveStartTime": 0,
    "EffectiveEndTime": 0,
    "TimeZone": 0,
    "CoverStaffInfos": [
        {
            "CoverStaffIDs": [
                "abc"
            ],
            "CoverStartTime": 0,
            "CoverEndTime": 0
        }
    ]
}

Output Example

{
    "Response": {
        "OnCallFormID": "abc",
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
UnsupportedOperation Unsupported operation.
Topik sebelumnya: DescribeOnCallFormsTopik selanjutnya: CreateOnCallForm

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan