Domain name for API request: monitor.intl.tencentcloudapi.com.
Describes on-call schedule list.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeOnCallForms. |
| 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. |
| Offset | Yes | Integer | Pagination start offset. |
| Limit | Yes | Integer | Number of pages for pagination query. |
| OnCallFormStaffIDs.N | No | Array of String | Supports searching based on user ID. |
| RotationType | No | String | Rotation type |
| Order | No | String | Sorting method. |
| OnCallFormName | No | String | Supports searching bay on ID and name. |
| Parameter Name | Type | Description |
|---|---|---|
| OnCallForms | Array of OnCallForm | On-call schedule information |
| TotalCount | Integer | Total number. |
| 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. |
This example shows you how to describe on-call schedule list.
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOnCallForms
<Common request parameters>
{
"Module": "abc",
"OnCallFormStaffIDs": [
"abc"
],
"RotationType": "abc",
"Offset": 0,
"Limit": 0,
"Order": "abc",
"OnCallFormName": "abc"
}
{
"Response": {
"OnCallForms": [
{
"OnCallFormID": "abc",
"OnCallFormName": "abc",
"OnCallFormDesc": "abc",
"RotationType": "abc",
"ShiftTime": "abc",
"EffectiveStartTime": 0,
"EffectiveEndTime": 0,
"TimeZone": 0,
"CurrOnCallStaffs": [
"abc"
]
}
],
"TotalCount": 0,
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈