tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstanceEvent

Last updated: 2024-04-15 11:08:56

1. API Description

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

This API is used to modify the operations event execution schedule of an instance.

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: ModifyInstanceEvent.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Specifies the instance ID. Example: crs-xjhsdj****. Log in to the TencentDB for Redis console and copy the instance ID in the instance list.
EventId Yes Integer Event ID. Obtain the ID of the event to be modified using DescribeInstanceEvents.
StartTime No String Modifies the scheduled start time of event execution.
EndTime No String Modifies the scheduled end time of event execution. After the start time is configured, the end time can only be 30 minutes, 1 hour, 1.5 hours, 2 hours, or 3 hours later than the start time.
ExecutionDate No String Modifies the start date of the event execution schedule.
Status No String Modifies the running status of the event. Currently, this parameter can be set only to Canceled, indicating that the execution of the current event is canceled. You can query the running status and level of the current event using DescribeInstanceEvents.- Critical or High events cannot be canceled, which means that they must be executed.- Only events in the Waiting state (to be executed) can be canceled.

3. Output Parameters

Parameter Name Type Description
EventId Integer Event 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 Modifying Instance Event Information

This example shows you how to modify the instance event information.

Input Example

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

{
    "InstanceId": "crs-b6wst31p",
    "EventId": 10,
    "StartTime": "22:00",
    "EndTime": "23:01",
    "ExecutionDate": "2023-09-18"
}

Output Example

{
    "Response": {
        "EventId": 10,
        "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
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InvalidParameter.InvalidParameter Invalid service parameter.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnsupportedOperation.InstanceNotOperation Unsupported operation
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy