Domain name for API request: csip.intl.tencentcloudapi.com.
Queries AI scheduled task trigger plans.
This API is used to query the future trigger plan list of a specified AI scheduled task within a given time window.
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: DescribeAISchedulePlanList. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| ScheduleId | No | String | AI scheduled task ID. You can obtain it through the DescribeAIScheduleList API. |
| StartTime | No | Integer | Start of preview window, Unix millisecond timestamp. 0 means current time. |
| EndTime | No | Integer | End time of the preview window, Unix millisecond timestamp. |
| Offset | No | Integer | Pagination offset. Default: 0. |
| Limit | No | Integer | Maximum return limit. Default: 20. Maximum: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| PlanSet | Array of AiSchedulePlanInfo | Trigger plan list. |
| TotalCount | Integer | Total quantity. |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAISchedulePlanList
<Common request parameters>
{
"ScheduleId": "sched-a1b2c3d4",
"StartTime": 1704067200000,
"EndTime": 1704153600000,
"Offset": 0,
"Limit": 10
}{
"Response": {
"PlanSet": [
{
"FireTime": 1775725829063,
"TriggerId": "trigger-mock-001",
"TriggerType": 1
}
],
"TotalCount": 3,
"RequestId": "de1463ad-426b-4970-8458-68f1208a907b"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| MissingParameter | Parameters are missing. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback