ModifySchedule

Last updated: 2023-10-12 16:44:37Download PDF

1. API Description

Domain name for API request: mps.tencentcloudapi.com.

This API is used to modify 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: ModifySchedule.
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.
ScheduleId	Yes	Integer	The scheme ID.
ScheduleName	No	String	The scheme name.
Trigger	No	WorkflowTrigger	The trigger of the scheme.
Activities.N	No	Array of Activity	The subtasks of the scheme. Note: You need to pass in the full list of subtasks even if you want to change only some of the subtasks.
OutputStorage	No	TaskOutputStorage	The bucket to save the output file.
OutputDir	No	String	The directory to save the media processing output file, which must start and end with `/`. Note: If this parameter is left empty, the current `OutputDir` value will be invalidated.
TaskNotifyConfig	No	TaskNotifyConfig	The notification configuration.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying a scheme

This example shows you how to modify a scheme.

Input Example

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

{
    "ScheduleId": 22435,
    "Trigger": {
        "Type": "AwsS3FileUpload",
        "AwsS3FileUploadTrigger": {
            "S3Bucket": "evanxia-test",
            "S3Region": "us-east-1",
            "Dir": "/input/"
        }
    }
}

Output Example

{
    "Response": {
        "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

Tencent Cloud CLI 3.0

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.
InvalidParameterValue	Incorrect parameter value.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.