DescribeSchedules
Last updated: 2023-10-12 16:44:38Download PDF
1. API Description
Domain name for API request: mps.tencentcloudapi.com.
This API is used to query a scheme.
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: DescribeSchedules. |
Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
ScheduleIds.N | No | Array of Integer | The IDs of the schemes to query. Array length limit: 100. |
TriggerType | No | String | The trigger type. Valid values:CosFileUpload : The scheme is triggered when a file is uploaded to Tencent Cloud Object Storage (COS).AwsS3FileUpload : The scheme is triggered when a file is uploaded to AWS S3.If you do not specify this parameter or leave it empty, all schemes will be returned regardless of the trigger type. |
Status | No | String | The scheme status. Valid values:Enabled Disabled If you do not specify this parameter, all schemes will be returned regardless of the status. |
Offset | No | Integer | The pagination offset. Default value: 0. |
Limit | No | Integer | The maximum number of records to return. Default value: 10. Maximum value: 100. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The total number of records that meet the conditions. |
ScheduleInfoSet | Array of SchedulesInfo | The information of the schemes. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying a scheme
This example shows you how to query the scheme whose ID is 0
.
Input Example
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSchedules
<Common request parameters>
{
"ScheduleIds": [
0
]
}
Output Example
{
"Response": {
"TotalCount": 0,
"ScheduleInfoSet": [],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
---|---|
FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
FailedOperation.InvalidUser | Operation failed: invalid user. |
InternalError | Internal error. |
InternalError.AccessDBError | Data error. |
InvalidParameter | Parameter error. |